iphplapi: Reorder defines for NetBSD.
[wine] / dlls / usp10 / usp10.c
1 /*
2  * Implementation of Uniscribe Script Processor (usp10.dll)
3  *
4  * Copyright 2005 Steven Edwards for CodeWeavers
5  * Copyright 2006 Hans Leidekker
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  *
21  * Notes:
22  * Uniscribe allows for processing of complex scripts such as joining
23  * and filtering characters and bi-directional text with custom line breaks.
24  */
25
26 #include <stdarg.h>
27
28 #include "windef.h"
29 #include "winbase.h"
30 #include "wingdi.h"
31 #include "winuser.h"
32 #include "winnls.h"
33 #include "usp10.h"
34
35 #include "wine/debug.h"
36 #include "wine/unicode.h"
37
38 WINE_DEFAULT_DEBUG_CHANNEL(uniscribe);
39
40 static const SCRIPT_PROPERTIES props[] =
41 {
42     { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
43     { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
44     { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
45     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
46     { 9, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
47     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
48     { 9, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
49     { 8, 0, 0, 0, 0, 161, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
50     { 25, 0, 0, 0, 0, 204, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
51     { 43, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
52     { 55, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
53     { 42, 0, 0, 0, 0, 163, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
54     { 9, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
55     { 0, 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0, 1, 0, 0 },
56     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
57     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
58     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
59     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
60     { 18, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
61     { 18, 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
62     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
63     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
64     { 9, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
65     { 9, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0 },
66     { 13, 0, 1, 0, 1, 177, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
67     { 13, 0, 1, 0, 0, 177, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
68     { 1, 0, 1, 0, 0, 178, 0, 0, 0, 0, 0, 0, 1, 1, 0 },
69     { 1, 1, 1, 0, 0, 178, 0, 0, 0, 0, 0, 0, 1, 0, 0 },
70     { 41, 1, 1, 0, 0, 178, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
71     { 32, 1, 1, 0, 0, 178, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
72     { 90, 0, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0 },
73     { 30, 0, 1, 1, 1, 222, 0, 0, 1, 0, 1, 0, 0, 0, 1 },
74     { 30, 1, 1, 0, 0, 222, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
75     { 30, 0, 1, 0, 0, 222, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
76     { 57, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
77     { 57, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
78     { 73, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
79     { 73, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
80     { 69, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
81     { 69, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
82     { 69, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
83     { 70, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
84     { 70, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
85     { 71, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
86     { 71, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
87     { 72, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
88     { 72, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
89     { 74, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
90     { 74, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
91     { 75, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
92     { 75, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
93     { 76, 0, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
94     { 76, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
95     { 81, 0, 1, 1, 1, 1, 0, 0, 1, 0, 1, 0, 0, 0, 0 },
96     { 81, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
97     { 84, 0, 1, 1, 1, 1, 0, 0, 1, 0, 1, 0, 0, 0, 0 },
98     { 84, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
99     { 83, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
100     { 83, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
101     { 85, 0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0 },
102     { 85, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
103     { 80, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
104     { 80, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
105     { 94, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
106     { 94, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
107     { 101, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
108     { 93, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
109     { 92, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
110     { 9, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
111     { 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
112     { 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
113     { 91, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
114     { 9, 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 },
115     { 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
116 };
117
118 static const SCRIPT_PROPERTIES *script_props[] =
119 {
120     &props[0], &props[1], &props[2], &props[3],
121     &props[4], &props[5], &props[6], &props[7],
122     &props[8], &props[9], &props[11], &props[12],
123     &props[13], &props[14], &props[15], &props[16],
124     &props[17], &props[18], &props[19], &props[20],
125     &props[21], &props[22], &props[23], &props[24],
126     &props[25], &props[26], &props[27], &props[28],
127     &props[29], &props[30], &props[31], &props[32],
128     &props[33], &props[34], &props[35], &props[36],
129     &props[37], &props[38], &props[39], &props[40],
130     &props[41], &props[42], &props[43], &props[44],
131     &props[45], &props[46], &props[47], &props[48],
132     &props[49], &props[50], &props[51], &props[52],
133     &props[53], &props[54], &props[55], &props[56],
134     &props[57], &props[58], &props[59], &props[60],
135     &props[61], &props[62], &props[63], &props[64],
136     &props[65], &props[66], &props[67], &props[68],
137     &props[69], &props[70], &props[71], &props[72],
138     &props[73]
139 };
140
141 #define GLYPH_BLOCK_SHIFT 8
142 #define GLYPH_BLOCK_SIZE  (1UL << GLYPH_BLOCK_SHIFT)
143 #define GLYPH_BLOCK_MASK  (GLYPH_BLOCK_SIZE - 1)
144 #define GLYPH_MAX         65536
145
146 typedef struct {
147     LOGFONTW lf;
148     TEXTMETRICW tm;
149     WORD *glyphs[GLYPH_MAX / GLYPH_BLOCK_SIZE];
150     ABC *widths[GLYPH_MAX / GLYPH_BLOCK_SIZE];
151 } ScriptCache;
152
153 typedef struct {
154     int numGlyphs;
155     WORD* glyphs;
156     WORD* pwLogClust;
157     int* piAdvance;
158     SCRIPT_VISATTR* psva;
159     GOFFSET* pGoffset;
160     ABC* abc;
161 } StringGlyphs;
162
163 typedef struct {
164     HDC hdc;
165     BOOL invalid;
166     int clip_len;
167     ScriptCache *sc;
168     int cItems;
169     int cMaxGlyphs;
170     SCRIPT_ITEM* pItem;
171     int numItems;
172     StringGlyphs* glyphs;
173     SCRIPT_LOGATTR* logattrs;
174     SIZE* sz;
175 } StringAnalysis;
176
177 static inline void *heap_alloc(SIZE_T size)
178 {
179     return HeapAlloc(GetProcessHeap(), 0, size);
180 }
181
182 static inline void *heap_alloc_zero(SIZE_T size)
183 {
184     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
185 }
186
187 static inline void *heap_realloc_zero(LPVOID mem, SIZE_T size)
188 {
189     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size);
190 }
191
192 static inline BOOL heap_free(LPVOID mem)
193 {
194     return HeapFree(GetProcessHeap(), 0, mem);
195 }
196
197 static inline WCHAR get_cache_default_char(SCRIPT_CACHE *psc)
198 {
199     return ((ScriptCache *)*psc)->tm.tmDefaultChar;
200 }
201
202 static inline LONG get_cache_height(SCRIPT_CACHE *psc)
203 {
204     return ((ScriptCache *)*psc)->tm.tmHeight;
205 }
206
207 static inline BYTE get_cache_pitch_family(SCRIPT_CACHE *psc)
208 {
209     return ((ScriptCache *)*psc)->tm.tmPitchAndFamily;
210 }
211
212 static inline WORD get_cache_glyph(SCRIPT_CACHE *psc, WCHAR c)
213 {
214     WORD *block = ((ScriptCache *)*psc)->glyphs[c >> GLYPH_BLOCK_SHIFT];
215
216     if (!block) return 0;
217     return block[c & GLYPH_BLOCK_MASK];
218 }
219
220 static inline WORD set_cache_glyph(SCRIPT_CACHE *psc, WCHAR c, WORD glyph)
221 {
222     WORD **block = &((ScriptCache *)*psc)->glyphs[c >> GLYPH_BLOCK_SHIFT];
223
224     if (!*block && !(*block = heap_alloc_zero(sizeof(WORD) * GLYPH_BLOCK_SIZE))) return 0;
225     return ((*block)[c & GLYPH_BLOCK_MASK] = glyph);
226 }
227
228 static inline BOOL get_cache_glyph_widths(SCRIPT_CACHE *psc, WORD glyph, ABC *abc)
229 {
230     static const ABC nil;
231     ABC *block = ((ScriptCache *)*psc)->widths[glyph >> GLYPH_BLOCK_SHIFT];
232
233     if (!block || !memcmp(&block[glyph & GLYPH_BLOCK_MASK], &nil, sizeof(ABC))) return FALSE;
234     memcpy(abc, &block[glyph & GLYPH_BLOCK_MASK], sizeof(ABC));
235     return TRUE;
236 }
237
238 static inline BOOL set_cache_glyph_widths(SCRIPT_CACHE *psc, WORD glyph, ABC *abc)
239 {
240     ABC **block = &((ScriptCache *)*psc)->widths[glyph >> GLYPH_BLOCK_SHIFT];
241
242     if (!*block && !(*block = heap_alloc_zero(sizeof(ABC) * GLYPH_BLOCK_SIZE))) return FALSE;
243     memcpy(&(*block)[glyph & GLYPH_BLOCK_MASK], abc, sizeof(ABC));
244     return TRUE;
245 }
246
247 static HRESULT init_script_cache(const HDC hdc, SCRIPT_CACHE *psc)
248 {
249     ScriptCache *sc;
250
251     if (!psc) return E_INVALIDARG;
252     if (*psc) return S_OK;
253     if (!hdc) return E_PENDING;
254
255     if (!(sc = heap_alloc_zero(sizeof(ScriptCache)))) return E_OUTOFMEMORY;
256     if (!GetTextMetricsW(hdc, &sc->tm))
257     {
258         heap_free(sc);
259         return E_INVALIDARG;
260     }
261     if (!GetObjectW(GetCurrentObject(hdc, OBJ_FONT), sizeof(LOGFONTW), &sc->lf))
262     {
263         heap_free(sc);
264         return E_INVALIDARG;
265     }
266     *psc = sc;
267     TRACE("<- %p\n", sc);
268     return S_OK;
269 }
270
271 /***********************************************************************
272  *      DllMain
273  *
274  */
275 BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID lpv)
276 {
277     switch(fdwReason)
278     {
279     case DLL_PROCESS_ATTACH:
280         DisableThreadLibraryCalls(hInstDLL);
281         break;
282     case DLL_PROCESS_DETACH:
283         break;
284     }
285     return TRUE;
286 }
287
288 /***********************************************************************
289  *      ScriptFreeCache (USP10.@)
290  *
291  * Free a script cache.
292  *
293  * PARAMS
294  *   psc [I/O] Script cache.
295  *
296  * RETURNS
297  *  Success: S_OK
298  *  Failure: Non-zero HRESULT value.
299  */
300 HRESULT WINAPI ScriptFreeCache(SCRIPT_CACHE *psc)
301 {
302     TRACE("%p\n", psc);
303
304     if (psc && *psc)
305     {
306         unsigned int i;
307         for (i = 0; i < GLYPH_MAX / GLYPH_BLOCK_SIZE; i++)
308         {
309             heap_free(((ScriptCache *)*psc)->glyphs[i]);
310             heap_free(((ScriptCache *)*psc)->widths[i]);
311         }
312         heap_free(*psc);
313         *psc = NULL;
314     }
315     return S_OK;
316 }
317
318 /***********************************************************************
319  *      ScriptGetProperties (USP10.@)
320  *
321  * Retrieve a list of script properties.
322  *
323  * PARAMS
324  *  props [I] Pointer to an array of SCRIPT_PROPERTIES pointers.
325  *  num   [I] Pointer to the number of scripts.
326  *
327  * RETURNS
328  *  Success: S_OK
329  *  Failure: Non-zero HRESULT value.
330  *
331  * NOTES
332  *  Behaviour matches WinXP.
333  */
334 HRESULT WINAPI ScriptGetProperties(const SCRIPT_PROPERTIES ***props, int *num)
335 {
336     TRACE("(%p,%p)\n", props, num);
337
338     if (!props && !num) return E_INVALIDARG;
339
340     if (num) *num = sizeof(script_props)/sizeof(script_props[0]);
341     if (props) *props = script_props;
342
343     return S_OK;
344 }
345
346 /***********************************************************************
347  *      ScriptGetFontProperties (USP10.@)
348  *
349  * Get information on special glyphs.
350  *
351  * PARAMS
352  *  hdc [I]   Device context.
353  *  psc [I/O] Opaque pointer to a script cache.
354  *  sfp [O]   Font properties structure.
355  */
356 HRESULT WINAPI ScriptGetFontProperties(HDC hdc, SCRIPT_CACHE *psc, SCRIPT_FONTPROPERTIES *sfp)
357 {
358     HRESULT hr;
359
360     TRACE("%p,%p,%p\n", hdc, psc, sfp);
361
362     if (!sfp) return E_INVALIDARG;
363     if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
364
365     if (sfp->cBytes != sizeof(SCRIPT_FONTPROPERTIES))
366         return E_INVALIDARG;
367
368     /* return something sensible? */
369     sfp->wgBlank = 0;
370     sfp->wgDefault = get_cache_default_char(psc);
371     sfp->wgInvalid = 0;
372     sfp->wgKashida = 0xffff;
373     sfp->iKashidaWidth = 0;
374
375     return S_OK;
376 }
377
378 /***********************************************************************
379  *      ScriptRecordDigitSubstitution (USP10.@)
380  *
381  *  Record digit substitution settings for a given locale.
382  *
383  *  PARAMS
384  *   locale [I] Locale identifier.
385  *   sds    [I] Structure to record substitution settings.
386  *
387  *  RETURNS
388  *   Success: S_OK
389  *   Failure: E_POINTER if sds is NULL, E_INVALIDARG otherwise.
390  *
391  *  SEE ALSO
392  *   http://blogs.msdn.com/michkap/archive/2006/02/22/536877.aspx
393  */
394 HRESULT WINAPI ScriptRecordDigitSubstitution(LCID locale, SCRIPT_DIGITSUBSTITUTE *sds)
395 {
396     DWORD plgid, sub;
397
398     TRACE("0x%x, %p\n", locale, sds);
399
400     /* This implementation appears to be correct for all languages, but it's
401      * not clear if sds->DigitSubstitute is ever set to anything except 
402      * CONTEXT or NONE in reality */
403
404     if (!sds) return E_POINTER;
405
406     locale = ConvertDefaultLocale(locale);
407
408     if (!IsValidLocale(locale, LCID_INSTALLED))
409         return E_INVALIDARG;
410
411     plgid = PRIMARYLANGID(LANGIDFROMLCID(locale));
412     sds->TraditionalDigitLanguage = plgid;
413
414     if (plgid == LANG_ARABIC || plgid == LANG_FARSI)
415         sds->NationalDigitLanguage = plgid;
416     else
417         sds->NationalDigitLanguage = LANG_ENGLISH;
418
419     if (!GetLocaleInfoW(locale, LOCALE_IDIGITSUBSTITUTION | LOCALE_RETURN_NUMBER,
420                         (LPWSTR)&sub, sizeof(sub)/sizeof(WCHAR))) return E_INVALIDARG;
421
422     switch (sub)
423     {
424     case 0: 
425         if (plgid == LANG_ARABIC || plgid == LANG_FARSI)
426             sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_CONTEXT;
427         else
428             sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_NONE;
429         break;
430     case 1:
431         sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_NONE;
432         break;
433     case 2:
434         sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_NATIONAL;
435         break;
436     default:
437         sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_TRADITIONAL;
438         break;
439     }
440
441     sds->dwReserved = 0;
442     return S_OK;
443 }
444
445 /***********************************************************************
446  *      ScriptApplyDigitSubstitution (USP10.@)
447  *
448  *  Apply digit substitution settings.
449  *
450  *  PARAMS
451  *   sds [I] Structure with recorded substitution settings.
452  *   sc  [I] Script control structure.
453  *   ss  [I] Script state structure.
454  *
455  *  RETURNS
456  *   Success: S_OK
457  *   Failure: E_INVALIDARG if sds is invalid. Otherwise an HRESULT.
458  */
459 HRESULT WINAPI ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE *sds, 
460                                             SCRIPT_CONTROL *sc, SCRIPT_STATE *ss)
461 {
462     SCRIPT_DIGITSUBSTITUTE psds;
463
464     TRACE("%p, %p, %p\n", sds, sc, ss);
465
466     if (!sc || !ss) return E_POINTER;
467     if (!sds)
468     {
469         sds = &psds;
470         if (ScriptRecordDigitSubstitution(LOCALE_USER_DEFAULT, &psds) != S_OK)
471             return E_INVALIDARG;
472     }
473
474     sc->uDefaultLanguage = LANG_ENGLISH;
475     sc->fContextDigits = 0;
476     ss->fDigitSubstitute = 0;
477
478     switch (sds->DigitSubstitute) {
479         case SCRIPT_DIGITSUBSTITUTE_CONTEXT:
480         case SCRIPT_DIGITSUBSTITUTE_NATIONAL:
481         case SCRIPT_DIGITSUBSTITUTE_NONE:
482         case SCRIPT_DIGITSUBSTITUTE_TRADITIONAL:
483             return S_OK;
484         default:
485             return E_INVALIDARG;
486     }
487 }
488
489 /***********************************************************************
490  *      ScriptItemize (USP10.@)
491  *
492  * Split a Unicode string into shapeable parts.
493  *
494  * PARAMS
495  *  pwcInChars [I] String to split.
496  *  cInChars   [I] Number of characters in pwcInChars.
497  *  cMaxItems  [I] Maximum number of items to return.
498  *  psControl  [I] Pointer to a SCRIPT_CONTROL structure.
499  *  psState    [I] Pointer to a SCRIPT_STATE structure.
500  *  pItems     [O] Buffer to receive SCRIPT_ITEM structures.
501  *  pcItems    [O] Number of script items returned.
502  *
503  * RETURNS
504  *  Success: S_OK
505  *  Failure: Non-zero HRESULT value.
506  */
507 HRESULT WINAPI ScriptItemize(const WCHAR *pwcInChars, int cInChars, int cMaxItems,
508                              const SCRIPT_CONTROL *psControl, const SCRIPT_STATE *psState,
509                              SCRIPT_ITEM *pItems, int *pcItems)
510 {
511
512 #define Numeric_start 0x0030
513 #define Numeric_stop  0x0039
514 #define Numeric_space 0x0020
515 #define Arabic_start  0x0600
516 #define Arabic_stop   0x06ff
517 #define Latin_start   0x0001
518 #define Latin_stop    0x024f
519 #define Script_Arabic  6
520 #define Script_Latin   1
521 #define Script_Numeric 5
522 #define Script_CR      22
523 #define Script_LF      23
524
525     int   cnt = 0, index = 0;
526     int   New_Script = SCRIPT_UNDEFINED;
527
528     TRACE("%s,%d,%d,%p,%p,%p,%p\n", debugstr_wn(pwcInChars, cInChars), cInChars, cMaxItems, 
529           psControl, psState, pItems, pcItems);
530
531     if (!pwcInChars || !cInChars || !pItems || cMaxItems < 2)
532         return E_INVALIDARG;
533
534     pItems[index].iCharPos = 0;
535     memset(&pItems[index].a, 0, sizeof(SCRIPT_ANALYSIS));
536
537     if  (pwcInChars[cnt] == '\r')
538         pItems[index].a.eScript = Script_CR;
539     else
540     if  (pwcInChars[cnt] == '\n')
541         pItems[index].a.eScript = Script_LF;
542     else
543     if  (pwcInChars[cnt] >= Numeric_start && pwcInChars[cnt] <= Numeric_stop)
544         pItems[index].a.eScript = Script_Numeric;
545     else
546     if  (pwcInChars[cnt] >= Arabic_start && pwcInChars[cnt] <= Arabic_stop)
547         pItems[index].a.eScript = Script_Arabic;
548     else
549     if  (pwcInChars[cnt] >= Latin_start && pwcInChars[cnt] <= Latin_stop)
550         pItems[index].a.eScript = Script_Latin;
551
552     if  (pItems[index].a.eScript  == Script_Arabic)
553         pItems[index].a.s.uBidiLevel = 1;
554
555     TRACE("New_Script=%d, eScript=%d index=%d cnt=%d iCharPos=%d\n",
556           New_Script, pItems[index].a.eScript, index, cnt,
557           pItems[index].iCharPos);
558
559     for (cnt=1; cnt < cInChars; cnt++)
560     {
561         if  (pwcInChars[cnt] == '\r')
562             New_Script = Script_CR;
563         else
564         if  (pwcInChars[cnt] == '\n')
565             New_Script = Script_LF;
566         else
567         if  ((pwcInChars[cnt] >= Numeric_start && pwcInChars[cnt] <= Numeric_stop)
568              || (New_Script == Script_Numeric && pwcInChars[cnt] == Numeric_space))
569             New_Script = Script_Numeric;
570         else
571         if  ((pwcInChars[cnt] >= Arabic_start && pwcInChars[cnt] <= Arabic_stop)
572              || (New_Script == Script_Arabic && pwcInChars[cnt] == Numeric_space))
573             New_Script = Script_Arabic;
574         else
575         if  ((pwcInChars[cnt] >= Latin_start && pwcInChars[cnt] <= Latin_stop)
576              || (New_Script == Script_Latin && pwcInChars[cnt] == Numeric_space))
577             New_Script = Script_Latin;
578         else
579             New_Script = SCRIPT_UNDEFINED;
580
581         if  (New_Script != pItems[index].a.eScript)
582         {
583             TRACE("New_Script=%d, eScript=%d ", New_Script, pItems[index].a.eScript);
584             index++;
585             if  (index+1 > cMaxItems)
586                 return E_OUTOFMEMORY;
587
588             pItems[index].iCharPos = cnt;
589             memset(&pItems[index].a, 0, sizeof(SCRIPT_ANALYSIS));
590
591             if  (New_Script == Script_Arabic)
592                 pItems[index].a.s.uBidiLevel = 1;
593
594             pItems[index].a.eScript = New_Script;
595             if  (New_Script == Script_Arabic)
596                 pItems[index].a.s.uBidiLevel = 1;
597
598             TRACE("index=%d cnt=%d iCharPos=%d\n", index, cnt, pItems[index].iCharPos);
599         }
600     }
601
602     /* While not strictly necessary according to the spec, make sure the n+1
603      * item is set up to prevent random behaviour if the caller erroneously
604      * checks the n+1 structure                                              */
605     memset(&pItems[index+1].a, 0, sizeof(SCRIPT_ANALYSIS));
606
607     TRACE("index=%d cnt=%d iCharPos=%d\n", index+1, cnt, pItems[index+1].iCharPos = cnt);
608
609     /*  Set one SCRIPT_STATE item being returned  */
610     if (pcItems) *pcItems = index + 1;
611
612     /*  Set SCRIPT_ITEM                                     */
613     pItems[index+1].iCharPos = cnt;       /* the last + 1 item
614                                              contains the ptr to the lastchar */
615     return S_OK;
616 }
617
618 /***********************************************************************
619  *      ScriptStringAnalyse (USP10.@)
620  *
621  */
622 HRESULT WINAPI ScriptStringAnalyse(HDC hdc, const void *pString, int cString,
623                                    int cGlyphs, int iCharset, DWORD dwFlags,
624                                    int iReqWidth, SCRIPT_CONTROL *psControl,
625                                    SCRIPT_STATE *psState, const int *piDx,
626                                    SCRIPT_TABDEF *pTabdef, const BYTE *pbInClass,
627                                    SCRIPT_STRING_ANALYSIS *pssa)
628 {
629     HRESULT hr = E_OUTOFMEMORY;
630     StringAnalysis *analysis = NULL;
631     int i, num_items = 255;
632
633     TRACE("(%p,%p,%d,%d,%d,0x%x,%d,%p,%p,%p,%p,%p,%p)\n",
634           hdc, pString, cString, cGlyphs, iCharset, dwFlags, iReqWidth,
635           psControl, psState, piDx, pTabdef, pbInClass, pssa);
636
637     if (iCharset != -1)
638     {
639         FIXME("Only Unicode strings are supported\n");
640         return E_INVALIDARG;
641     }
642     if (cString < 1 || !pString) return E_INVALIDARG;
643     if ((dwFlags & SSA_GLYPHS) && !hdc) return E_PENDING;
644
645     if (!(analysis = heap_alloc_zero(sizeof(StringAnalysis)))) return E_OUTOFMEMORY;
646     if (!(analysis->pItem = heap_alloc_zero(num_items * sizeof(SCRIPT_ITEM) + 1))) goto error;
647
648     /* FIXME: handle clipping */
649     analysis->clip_len = cString;
650     analysis->hdc = hdc;
651
652     hr = ScriptItemize(pString, cString, num_items, psControl, psState, analysis->pItem,
653                        &analysis->numItems);
654
655     while (hr == E_OUTOFMEMORY)
656     {
657         SCRIPT_ITEM *tmp;
658
659         num_items *= 2;
660         if (!(tmp = heap_realloc_zero(analysis->pItem, num_items * sizeof(SCRIPT_ITEM) + 1)))
661             goto error;
662
663         analysis->pItem = tmp;
664         hr = ScriptItemize(pString, cString, num_items, psControl, psState, analysis->pItem,
665                            &analysis->numItems);
666     }
667     if (hr != S_OK) goto error;
668
669     if ((analysis->logattrs = heap_alloc(sizeof(SCRIPT_LOGATTR) * cString)))
670         ScriptBreak(pString, cString, (SCRIPT_STRING_ANALYSIS)analysis, analysis->logattrs);
671     else
672         goto error;
673
674     if (!(analysis->glyphs = heap_alloc_zero(sizeof(StringGlyphs) * analysis->numItems)))
675         goto error;
676
677     for (i = 0; i < analysis->numItems; i++)
678     {
679         SCRIPT_CACHE *sc = (SCRIPT_CACHE *)&analysis->sc;
680         int cChar = analysis->pItem[i+1].iCharPos - analysis->pItem[i].iCharPos;
681         int numGlyphs = 1.5 * cChar + 16;
682         WORD *glyphs = heap_alloc_zero(sizeof(WORD) * numGlyphs);
683         WORD *pwLogClust = heap_alloc_zero(sizeof(WORD) * cChar);
684         int *piAdvance = heap_alloc_zero(sizeof(int) * numGlyphs);
685         SCRIPT_VISATTR *psva = heap_alloc_zero(sizeof(SCRIPT_VISATTR) * cChar);
686         GOFFSET *pGoffset = heap_alloc_zero(sizeof(GOFFSET) * numGlyphs);
687         ABC *abc = heap_alloc_zero(sizeof(ABC));
688         int numGlyphsReturned;
689
690         /* FIXME: non unicode strings */
691         WCHAR* pStr = (WCHAR*)pString;
692         hr = ScriptShape(hdc, sc, &pStr[analysis->pItem[i].iCharPos],
693                          cChar, numGlyphs, &analysis->pItem[i].a,
694                          glyphs, pwLogClust, psva, &numGlyphsReturned);
695         hr = ScriptPlace(hdc, sc, glyphs, numGlyphsReturned, psva, &analysis->pItem[i].a,
696                          piAdvance, pGoffset, abc);
697
698         analysis->glyphs[i].numGlyphs = numGlyphsReturned;
699         analysis->glyphs[i].glyphs = glyphs;
700         analysis->glyphs[i].pwLogClust = pwLogClust;
701         analysis->glyphs[i].piAdvance = piAdvance;
702         analysis->glyphs[i].psva = psva;
703         analysis->glyphs[i].pGoffset = pGoffset;
704         analysis->glyphs[i].abc = abc;
705     }
706
707     *pssa = analysis;
708     return S_OK;
709
710 error:
711     heap_free(analysis->glyphs);
712     heap_free(analysis->logattrs);
713     heap_free(analysis->pItem);
714     heap_free(analysis->sc);
715     heap_free(analysis);
716     return hr;
717 }
718
719 /***********************************************************************
720  *      ScriptStringOut (USP10.@)
721  *
722  * This function takes the output of ScriptStringAnalyse and joins the segments
723  * of glyphs and passes the resulting string to ScriptTextOut.  ScriptStringOut
724  * only processes glyphs.
725  *
726  * Parameters:
727  *  ssa       [I] buffer to hold the analysed string components
728  *  iX        [I] X axis displacement for output
729  *  iY        [I] Y axis displacement for output
730  *  uOptions  [I] flags controling output processing
731  *  prc       [I] rectangle coordinates
732  *  iMinSel   [I] starting pos for substringing output string
733  *  iMaxSel   [I] ending pos for substringing output string
734  *  fDisabled [I] controls text highlighting
735  *
736  *  RETURNS
737  *   Success: S_OK
738  *   Failure: is the value returned by ScriptTextOut
739  */
740 HRESULT WINAPI ScriptStringOut(SCRIPT_STRING_ANALYSIS ssa,
741                                int iX,
742                                int iY, 
743                                UINT uOptions, 
744                                const RECT *prc, 
745                                int iMinSel, 
746                                int iMaxSel,
747                                BOOL fDisabled)
748 {
749     StringAnalysis *analysis;
750     WORD *glyphs;
751     int   item, cnt, x;
752     HRESULT hr;
753
754     TRACE("(%p,%d,%d,0x%1x,%p,%d,%d,%d)\n",
755          ssa, iX, iY, uOptions, prc, iMinSel, iMaxSel, fDisabled);
756
757     if (!(analysis = ssa)) return E_INVALIDARG;
758
759     /*
760      * Get storage for the output buffer for the consolidated strings
761      */
762     cnt = 0;
763     for (item = 0; item < analysis->numItems; item++)
764     {
765         cnt += analysis->glyphs[item].numGlyphs;
766     }
767     if (!(glyphs = heap_alloc(sizeof(WCHAR) * cnt))) return E_OUTOFMEMORY;
768
769     /*
770      * ScriptStringOut only processes glyphs hence set ETO_GLYPH_INDEX
771      */
772     uOptions |= ETO_GLYPH_INDEX;
773     analysis->pItem[0].a.fNoGlyphIndex = FALSE; /* say that we have glyphs */
774
775     /*
776      * Copy the string items into the output buffer
777      */
778
779     TRACE("numItems %d\n", analysis->numItems);
780
781     cnt = 0;
782     for (item = 0; item < analysis->numItems; item++)
783     {
784         memcpy(&glyphs[cnt], analysis->glyphs[item].glyphs,
785               sizeof(WCHAR) * analysis->glyphs[item].numGlyphs);
786
787         TRACE("Item %d, Glyphs %d ", item, analysis->glyphs[item].numGlyphs);
788         for (x = cnt; x < analysis->glyphs[item].numGlyphs + cnt; x ++)
789             TRACE("%04x", glyphs[x]);
790         TRACE("\n");
791
792         cnt += analysis->glyphs[item].numGlyphs; /* point to the end of the copied text */
793     }
794
795     hr = ScriptTextOut(analysis->hdc, (SCRIPT_CACHE *)&analysis->sc, iX, iY,
796                        uOptions, prc, &analysis->pItem->a, NULL, 0, glyphs, cnt,
797                        analysis->glyphs->piAdvance, NULL, analysis->glyphs->pGoffset);
798     TRACE("ScriptTextOut hr=%08x\n", hr);
799
800     /*
801      * Free the output buffer and script cache
802      */
803     heap_free(glyphs);
804     return hr;
805 }
806
807 /***********************************************************************
808  *      ScriptStringCPtoX (USP10.@)
809  *
810  */
811 HRESULT WINAPI ScriptStringCPtoX(SCRIPT_STRING_ANALYSIS ssa, int icp, BOOL fTrailing, int* pX)
812 {
813     int i, j;
814     int runningX = 0;
815     int runningCp = 0;
816     StringAnalysis* analysis = ssa;
817
818     TRACE("(%p), %d, %d, (%p)\n", ssa, icp, fTrailing, pX);
819
820     if (!ssa || !pX) return S_FALSE;
821
822     /* icp out of range */
823     if(icp < 0)
824     {
825         analysis->invalid = TRUE;
826         return E_INVALIDARG;
827     }
828
829     for(i=0; i<analysis->numItems; i++)
830     {
831         for(j=0; j<analysis->glyphs[i].numGlyphs; j++)
832         {
833             if(runningCp == icp && fTrailing == FALSE)
834             {
835                 *pX = runningX;
836                 return S_OK;
837             }
838             runningX += analysis->glyphs[i].piAdvance[j];
839             if(runningCp == icp && fTrailing == TRUE)
840             {
841                 *pX = runningX;
842                 return S_OK;
843             }
844             runningCp++;
845         }
846     }
847
848     /* icp out of range */
849     analysis->invalid = TRUE;
850     return E_INVALIDARG;
851 }
852
853 /***********************************************************************
854  *      ScriptStringXtoCP (USP10.@)
855  *
856  */
857 HRESULT WINAPI ScriptStringXtoCP(SCRIPT_STRING_ANALYSIS ssa, int iX, int* piCh, int* piTrailing) 
858 {
859     StringAnalysis* analysis = ssa;
860     int i;
861     int j;
862     int runningX = 0;
863     int runningCp = 0;
864     int width;
865
866     TRACE("(%p), %d, (%p), (%p)\n", ssa, iX, piCh, piTrailing);
867
868     if (!ssa || !piCh || !piTrailing) return S_FALSE;
869
870     /* out of range */
871     if(iX < 0)
872     {
873         *piCh = -1;
874         *piTrailing = TRUE;
875         return S_OK;
876     }
877
878     for(i=0; i<analysis->numItems; i++)
879     {
880         for(j=0; j<analysis->glyphs[i].numGlyphs; j++)
881         {
882             width = analysis->glyphs[i].piAdvance[j];
883             if(iX < (runningX + width))
884             {
885                 *piCh = runningCp;
886                 if((iX - runningX) > width/2)
887                     *piTrailing = TRUE;
888                 else
889                     *piTrailing = FALSE;
890                 return S_OK;
891             }
892             runningX += width;
893             runningCp++;
894         }
895     }
896
897     /* out of range */
898     *piCh = analysis->pItem[analysis->numItems].iCharPos;
899     *piTrailing = FALSE;
900
901     return S_OK;
902 }
903
904
905 /***********************************************************************
906  *      ScriptStringFree (USP10.@)
907  *
908  * Free a string analysis.
909  *
910  * PARAMS
911  *  pssa [I] string analysis.
912  *
913  * RETURNS
914  *  Success: S_OK
915  *  Failure: Non-zero HRESULT value.
916  */
917 HRESULT WINAPI ScriptStringFree(SCRIPT_STRING_ANALYSIS *pssa)
918 {
919     StringAnalysis* analysis;
920     BOOL invalid;
921     int i;
922
923     TRACE("(%p)\n", pssa);
924
925     if (!pssa || !(analysis = *pssa)) return E_INVALIDARG;
926     invalid = analysis->invalid;
927
928     for (i = 0; i < analysis->numItems; i++)
929     {
930         heap_free(analysis->glyphs[i].glyphs);
931         heap_free(analysis->glyphs[i].pwLogClust);
932         heap_free(analysis->glyphs[i].piAdvance);
933         heap_free(analysis->glyphs[i].psva);
934         heap_free(analysis->glyphs[i].pGoffset);
935         heap_free(analysis->glyphs[i].abc);
936     }
937
938     heap_free(analysis->glyphs);
939     heap_free(analysis->pItem);
940     heap_free(analysis->logattrs);
941     heap_free(analysis->sz);
942     heap_free(analysis->sc);
943     heap_free(analysis);
944
945     if (invalid) return E_INVALIDARG;
946     return S_OK;
947 }
948
949 /***********************************************************************
950  *      ScriptCPtoX (USP10.@)
951  *
952  */
953 HRESULT WINAPI ScriptCPtoX(int iCP,
954                            BOOL fTrailing,
955                            int cChars,
956                            int cGlyphs,
957                            const WORD *pwLogClust,
958                            const SCRIPT_VISATTR *psva,
959                            const int *piAdvance,
960                            const SCRIPT_ANALYSIS *psa,
961                            int *piX)
962 {
963     int  item;
964     int  iPosX;
965     float  fMaxPosX = 0;
966     TRACE("(%d,%d,%d,%d,%p,%p,%p,%p,%p)\n",
967           iCP, fTrailing, cChars, cGlyphs, pwLogClust, psva, piAdvance,
968           psa, piX);
969     for (item=0; item < cGlyphs; item++)            /* total piAdvance           */
970         fMaxPosX += piAdvance[item];
971     iPosX = (fMaxPosX/cGlyphs)*(iCP+fTrailing);
972     if  (iPosX > fMaxPosX)
973         iPosX = fMaxPosX;
974     *piX = iPosX;                                    /* Return something in range */
975
976     TRACE("*piX=%d\n", *piX);
977     return S_OK;
978 }
979
980 /***********************************************************************
981  *      ScriptXtoCP (USP10.@)
982  *
983  */
984 HRESULT WINAPI ScriptXtoCP(int iX,
985                            int cChars,
986                            int cGlyphs,
987                            const WORD *pwLogClust,
988                            const SCRIPT_VISATTR *psva,
989                            const int *piAdvance,
990                            const SCRIPT_ANALYSIS *psa,
991                            int *piCP,
992                            int *piTrailing)
993 {
994     int item;
995     int iPosX;
996     float fMaxPosX = 1;
997     float fAvePosX;
998     TRACE("(%d,%d,%d,%p,%p,%p,%p,%p,%p)\n",
999           iX, cChars, cGlyphs, pwLogClust, psva, piAdvance,
1000           psa, piCP, piTrailing);
1001     if  (iX < 0)                                    /* iX is before start of run */
1002     {
1003         *piCP = -1;
1004         *piTrailing = TRUE;
1005         return S_OK;
1006     }
1007
1008     for (item=0; item < cGlyphs; item++)            /* total piAdvance           */
1009         fMaxPosX += piAdvance[item];
1010
1011     if  (iX >= fMaxPosX)                            /* iX too large              */
1012     {
1013         *piCP = cChars;
1014         *piTrailing = FALSE;
1015         return S_OK;
1016     }
1017
1018     fAvePosX = fMaxPosX / cGlyphs;
1019     iPosX = fAvePosX;
1020     for (item = 1; item < cGlyphs  && iPosX < iX; item++)
1021         iPosX += fAvePosX;
1022     if  (iPosX - iX > fAvePosX/2)
1023         *piTrailing = 0;
1024     else
1025         *piTrailing = 1;                            /* yep we are over halfway */
1026
1027     *piCP = item -1;                                /* Return character position */
1028     TRACE("*piCP=%d iPposX=%d\n", *piCP, iPosX);
1029     return S_OK;
1030 }
1031
1032 /***********************************************************************
1033  *      ScriptBreak (USP10.@)
1034  *
1035  *  Retrieve line break information.
1036  *
1037  *  PARAMS
1038  *   chars [I] Array of characters.
1039  *   sa    [I] String analysis.
1040  *   la    [I] Array of logical attribute structures.
1041  *
1042  *  RETURNS
1043  *   Success: S_OK
1044  *   Failure: S_FALSE
1045  */
1046 HRESULT WINAPI ScriptBreak(const WCHAR *chars, int count, const SCRIPT_ANALYSIS *sa, SCRIPT_LOGATTR *la)
1047 {
1048     int i;
1049
1050     TRACE("(%s, %d, %p, %p)\n", debugstr_wn(chars, count), count, sa, la);
1051
1052     if (!la) return S_FALSE;
1053
1054     for (i = 0; i < count; i++)
1055     {
1056         memset(&la[i], 0, sizeof(SCRIPT_LOGATTR));
1057
1058         /* FIXME: set the other flags */
1059         la[i].fWhiteSpace = (chars[i] == ' ');
1060         la[i].fCharStop = 1;
1061
1062         if (i > 0 && la[i - 1].fWhiteSpace)
1063         {
1064             la[i].fSoftBreak = 1;
1065             la[i].fWordStop = 1;
1066         }
1067     }
1068     return S_OK;
1069 }
1070
1071 static const struct
1072 {
1073     WCHAR start;
1074     WCHAR end;
1075     DWORD flag;
1076 }
1077 complex_ranges[] =
1078 {
1079     { 0, 0x0b, SIC_COMPLEX },
1080     { 0x0c, 0x0c, SIC_NEUTRAL },
1081     { 0x0d, 0x1f, SIC_COMPLEX },
1082     { 0x20, 0x2f, SIC_NEUTRAL },
1083     { 0x30, 0x39, SIC_ASCIIDIGIT },
1084     { 0x3a, 0x40, SIC_NEUTRAL },
1085     { 0x5b, 0x60, SIC_NEUTRAL },
1086     { 0x7b, 0x7e, SIC_NEUTRAL },
1087     { 0x7f, 0x9f, SIC_COMPLEX },
1088     { 0xa0, 0xa5, SIC_NEUTRAL },
1089     { 0xa7, 0xa8, SIC_NEUTRAL },
1090     { 0xab, 0xab, SIC_NEUTRAL },
1091     { 0xad, 0xad, SIC_NEUTRAL },
1092     { 0xaf, 0xaf, SIC_NEUTRAL },
1093     { 0xb0, 0xb1, SIC_NEUTRAL },
1094     { 0xb4, 0xb4, SIC_NEUTRAL },
1095     { 0xb6, 0xb8, SIC_NEUTRAL },
1096     { 0xbb, 0xbf, SIC_NEUTRAL },
1097     { 0xd7, 0xd7, SIC_NEUTRAL },
1098     { 0xf7, 0xf7, SIC_NEUTRAL },
1099     { 0x2b9, 0x2ba, SIC_NEUTRAL },
1100     { 0x2c2, 0x2cf, SIC_NEUTRAL },
1101     { 0x2d2, 0x2df, SIC_NEUTRAL },
1102     { 0x2e5, 0x2e9, SIC_COMPLEX },
1103     { 0x2ea, 0x2ed, SIC_NEUTRAL },
1104     { 0x300, 0x362, SIC_COMPLEX },
1105     { 0x530, 0x60b, SIC_COMPLEX },
1106     { 0x60c, 0x60d, SIC_NEUTRAL },
1107     { 0x60e, 0x669, SIC_COMPLEX },
1108     { 0x66a, 0x66a, SIC_NEUTRAL },
1109     { 0x66b, 0x6e8, SIC_COMPLEX },
1110     { 0x6e9, 0x6e9, SIC_NEUTRAL },
1111     { 0x6ea, 0x7bf, SIC_COMPLEX },
1112     { 0x900, 0x1360, SIC_COMPLEX },
1113     { 0x137d, 0x137f, SIC_COMPLEX },
1114     { 0x1680, 0x1680, SIC_NEUTRAL },
1115     { 0x1780, 0x18af, SIC_COMPLEX },
1116     { 0x2000, 0x200a, SIC_NEUTRAL },
1117     { 0x200b, 0x200f, SIC_COMPLEX },
1118     { 0x2010, 0x2016, SIC_NEUTRAL },
1119     { 0x2018, 0x2022, SIC_NEUTRAL },
1120     { 0x2024, 0x2028, SIC_NEUTRAL },
1121     { 0x2029, 0x202e, SIC_COMPLEX },
1122     { 0x202f, 0x2037, SIC_NEUTRAL },
1123     { 0x2039, 0x203c, SIC_NEUTRAL },
1124     { 0x2044, 0x2046, SIC_NEUTRAL },
1125     { 0x206a, 0x206f, SIC_COMPLEX },
1126     { 0x207a, 0x207e, SIC_NEUTRAL },
1127     { 0x208a, 0x20aa, SIC_NEUTRAL },
1128     { 0x20ac, 0x20cf, SIC_NEUTRAL },
1129     { 0x20d0, 0x20ff, SIC_COMPLEX },
1130     { 0x2103, 0x2103, SIC_NEUTRAL },
1131     { 0x2105, 0x2105, SIC_NEUTRAL },
1132     { 0x2109, 0x2109, SIC_NEUTRAL },
1133     { 0x2116, 0x2116, SIC_NEUTRAL },
1134     { 0x2121, 0x2122, SIC_NEUTRAL },
1135     { 0x212e, 0x212e, SIC_NEUTRAL },
1136     { 0x2153, 0x2154, SIC_NEUTRAL },
1137     { 0x215b, 0x215e, SIC_NEUTRAL },
1138     { 0x2190, 0x2199, SIC_NEUTRAL },
1139     { 0x21b8, 0x21b9, SIC_NEUTRAL },
1140     { 0x21d2, 0x21d2, SIC_NEUTRAL },
1141     { 0x21d4, 0x21d4, SIC_NEUTRAL },
1142     { 0x21e7, 0x21e7, SIC_NEUTRAL },
1143     { 0x2200, 0x2200, SIC_NEUTRAL },
1144     { 0x2202, 0x2203, SIC_NEUTRAL },
1145     { 0x2207, 0x2208, SIC_NEUTRAL },
1146     { 0x220b, 0x220b, SIC_NEUTRAL },
1147     { 0x220f, 0x220f, SIC_NEUTRAL },
1148     { 0x2211, 0x2213, SIC_NEUTRAL },
1149     { 0x2215, 0x2215, SIC_NEUTRAL },
1150     { 0x221a, 0x221a, SIC_NEUTRAL },
1151     { 0x221d, 0x2220, SIC_NEUTRAL },
1152     { 0x2223, 0x2223, SIC_NEUTRAL },
1153     { 0x2225, 0x2225, SIC_NEUTRAL },
1154     { 0x2227, 0x222c, SIC_NEUTRAL },
1155     { 0x222e, 0x222e, SIC_NEUTRAL },
1156     { 0x2234, 0x2237, SIC_NEUTRAL },
1157     { 0x223c, 0x223d, SIC_NEUTRAL },
1158     { 0x2248, 0x2248, SIC_NEUTRAL },
1159     { 0x224c, 0x224c, SIC_NEUTRAL },
1160     { 0x2252, 0x2252, SIC_NEUTRAL },
1161     { 0x2260, 0x2261, SIC_NEUTRAL },
1162     { 0x2264, 0x2267, SIC_NEUTRAL },
1163     { 0x226a, 0x226b, SIC_NEUTRAL },
1164     { 0x226e, 0x226f, SIC_NEUTRAL },
1165     { 0x2282, 0x2283, SIC_NEUTRAL },
1166     { 0x2286, 0x2287, SIC_NEUTRAL },
1167     { 0x2295, 0x2295, SIC_NEUTRAL },
1168     { 0x2299, 0x2299, SIC_NEUTRAL },
1169     { 0x22a5, 0x22a5, SIC_NEUTRAL },
1170     { 0x22bf, 0x22bf, SIC_NEUTRAL },
1171     { 0x2312, 0x2312, SIC_NEUTRAL },
1172     { 0x24ea, 0x24ea, SIC_COMPLEX },
1173     { 0x2500, 0x254b, SIC_NEUTRAL },
1174     { 0x2550, 0x256d, SIC_NEUTRAL },
1175     { 0x256e, 0x2574, SIC_NEUTRAL },
1176     { 0x2581, 0x258f, SIC_NEUTRAL },
1177     { 0x2592, 0x2595, SIC_NEUTRAL },
1178     { 0x25a0, 0x25a1, SIC_NEUTRAL },
1179     { 0x25a3, 0x25a9, SIC_NEUTRAL },
1180     { 0x25b2, 0x25b3, SIC_NEUTRAL },
1181     { 0x25b6, 0x25b7, SIC_NEUTRAL },
1182     { 0x25bc, 0x25bd, SIC_NEUTRAL },
1183     { 0x25c0, 0x25c1, SIC_NEUTRAL },
1184     { 0x25c6, 0x25c8, SIC_NEUTRAL },
1185     { 0x25cb, 0x25cb, SIC_NEUTRAL },
1186     { 0x25ce, 0x25d1, SIC_NEUTRAL },
1187     { 0x25e2, 0x25e5, SIC_NEUTRAL },
1188     { 0x25ef, 0x25ef, SIC_NEUTRAL },
1189     { 0x2605, 0x2606, SIC_NEUTRAL },
1190     { 0x2609, 0x2609, SIC_NEUTRAL },
1191     { 0x260e, 0x260f, SIC_NEUTRAL },
1192     { 0x261c, 0x261c, SIC_NEUTRAL },
1193     { 0x261e, 0x261e, SIC_NEUTRAL },
1194     { 0x2640, 0x2640, SIC_NEUTRAL },
1195     { 0x2642, 0x2642, SIC_NEUTRAL },
1196     { 0x2660, 0x2661, SIC_NEUTRAL },
1197     { 0x2663, 0x2665, SIC_NEUTRAL },
1198     { 0x2667, 0x266a, SIC_NEUTRAL },
1199     { 0x266c, 0x266d, SIC_NEUTRAL },
1200     { 0x266f, 0x266f, SIC_NEUTRAL },
1201     { 0x273d, 0x273d, SIC_NEUTRAL },
1202     { 0x2e80, 0x312f, SIC_COMPLEX },
1203     { 0x3190, 0x31bf, SIC_COMPLEX },
1204     { 0x31f0, 0x31ff, SIC_COMPLEX },
1205     { 0x3220, 0x325f, SIC_COMPLEX },
1206     { 0x3280, 0xa4ff, SIC_COMPLEX },
1207     { 0xd800, 0xdfff, SIC_COMPLEX },
1208     { 0xe000, 0xf8ff, SIC_NEUTRAL },
1209     { 0xf900, 0xfaff, SIC_COMPLEX },
1210     { 0xfb13, 0xfb28, SIC_COMPLEX },
1211     { 0xfb29, 0xfb29, SIC_NEUTRAL },
1212     { 0xfb2a, 0xfb4f, SIC_COMPLEX },
1213     { 0xfd3e, 0xfd3f, SIC_NEUTRAL },
1214     { 0xfdd0, 0xfdef, SIC_COMPLEX },
1215     { 0xfe20, 0xfe6f, SIC_COMPLEX },
1216     { 0xfeff, 0xfeff, SIC_COMPLEX },
1217     { 0xff01, 0xff5e, SIC_COMPLEX },
1218     { 0xff61, 0xff9f, SIC_COMPLEX },
1219     { 0xffe0, 0xffe6, SIC_COMPLEX },
1220     { 0xffe8, 0xffee, SIC_COMPLEX },
1221     { 0xfff9, 0xfffb, SIC_COMPLEX },
1222     { 0xfffe, 0xfffe, SIC_COMPLEX }
1223 };
1224
1225 /***********************************************************************
1226  *      ScriptIsComplex (USP10.@)
1227  * 
1228  *  Determine if a string is complex.
1229  *
1230  *  PARAMS
1231  *   chars [I] Array of characters to test.
1232  *   len   [I] Length in characters.
1233  *   flag  [I] Flag.
1234  *
1235  *  RETURNS
1236  *   Success: S_OK
1237  *   Failure: S_FALSE
1238  *
1239  *  NOTES
1240  *   Behaviour matches that of WinXP.
1241  */
1242 HRESULT WINAPI ScriptIsComplex(const WCHAR *chars, int len, DWORD flag)
1243 {
1244     int i;
1245     unsigned int j;
1246
1247     TRACE("(%s,%d,0x%x)\n", debugstr_wn(chars, len), len, flag);
1248
1249     for (i = 0; i < len; i++)
1250     {
1251         for (j = 0; j < sizeof(complex_ranges)/sizeof(complex_ranges[0]); j++)
1252         {
1253             if (chars[i] >= complex_ranges[j].start &&
1254                 chars[i] <= complex_ranges[j].end &&
1255                 (flag & complex_ranges[j].flag)) return S_OK;
1256         }
1257     }
1258     return S_FALSE;
1259 }
1260
1261 /***********************************************************************
1262  *      ScriptShape (USP10.@)
1263  *
1264  * Produce glyphs and visual attributes for a run.
1265  *
1266  * PARAMS
1267  *  hdc         [I]   Device context.
1268  *  psc         [I/O] Opaque pointer to a script cache.
1269  *  pwcChars    [I]   Array of characters specifying the run.
1270  *  cChars      [I]   Number of characters in pwcChars.
1271  *  cMaxGlyphs  [I]   Length of pwOutGlyphs.
1272  *  psa         [I/O] Script analysis.
1273  *  pwOutGlyphs [O]   Array of glyphs.
1274  *  pwLogClust  [O]   Array of logical cluster info.
1275  *  psva        [O]   Array of visual attributes.
1276  *  pcGlyphs    [O]   Number of glyphs returned.
1277  *
1278  * RETURNS
1279  *  Success: S_OK
1280  *  Failure: Non-zero HRESULT value.
1281  */
1282 HRESULT WINAPI ScriptShape(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcChars, 
1283                            int cChars, int cMaxGlyphs,
1284                            SCRIPT_ANALYSIS *psa, WORD *pwOutGlyphs, WORD *pwLogClust,
1285                            SCRIPT_VISATTR *psva, int *pcGlyphs)
1286 {
1287     HRESULT hr;
1288     unsigned int i;
1289
1290     TRACE("(%p, %p, %s, %d, %d, %p, %p, %p, %p, %p)\n", hdc, psc, debugstr_wn(pwcChars, cChars),
1291           cChars, cMaxGlyphs, psa, pwOutGlyphs, pwLogClust, psva, pcGlyphs);
1292
1293     if (psa) TRACE("psa values: %d, %d, %d, %d, %d, %d, %d\n", psa->eScript, psa->fRTL, psa->fLayoutRTL,
1294                    psa->fLinkBefore, psa->fLinkAfter, psa->fLogicalOrder, psa->fNoGlyphIndex);
1295
1296     if (!psva || !pcGlyphs) return E_INVALIDARG;
1297     if (cChars > cMaxGlyphs) return E_OUTOFMEMORY;
1298
1299     *pcGlyphs = cChars;
1300     if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1301
1302     if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE) && !psa->fNoGlyphIndex)
1303     {
1304         for (i = 0; i < cChars; i++)
1305         {
1306             if (!(pwOutGlyphs[i] = get_cache_glyph(psc, pwcChars[i])))
1307             {
1308                 WORD glyph;
1309                 if (!hdc) return E_PENDING;
1310                 if (GetGlyphIndicesW(hdc, &pwcChars[i], 1, &glyph, GGI_MARK_NONEXISTING_GLYPHS) == GDI_ERROR) return S_FALSE;
1311                 pwOutGlyphs[i] = set_cache_glyph(psc, pwcChars[i], glyph);
1312             }
1313         }
1314     }
1315     else
1316     {
1317         TRACE("no glyph translation\n");
1318         for (i = 0; i < cChars; i++) pwOutGlyphs[i] = pwcChars[i];
1319     }
1320
1321     if (psva)
1322     {
1323         /* set up a valid SCRIPT_VISATTR and LogClust for each char in this run */
1324         for (i = 0; i < cChars; i++)
1325         {
1326             /* FIXME: set to better values */
1327             psva[i].uJustification = (pwcChars[i] == ' ') ? SCRIPT_JUSTIFY_BLANK : SCRIPT_JUSTIFY_CHARACTER;
1328             psva[i].fClusterStart  = 1;
1329             psva[i].fDiacritic     = 0;
1330             psva[i].fZeroWidth     = 0;
1331             psva[i].fReserved      = 0;
1332             psva[i].fShapeReserved = 0;
1333
1334             if (pwLogClust) pwLogClust[i] = i;
1335         }
1336     }
1337     return S_OK;
1338 }
1339
1340 /***********************************************************************
1341  *      ScriptPlace (USP10.@)
1342  *
1343  * Produce advance widths for a run.
1344  *
1345  * PARAMS
1346  *  hdc       [I]   Device context.
1347  *  psc       [I/O] Opaque pointer to a script cache.
1348  *  pwGlyphs  [I]   Array of glyphs.
1349  *  cGlyphs   [I]   Number of glyphs in pwGlyphs.
1350  *  psva      [I]   Array of visual attributes.
1351  *  psa       [I/O] String analysis.
1352  *  piAdvance [O]   Array of advance widths.
1353  *  pGoffset  [O]   Glyph offsets.
1354  *  pABC      [O]   Combined ABC width.
1355  *
1356  * RETURNS
1357  *  Success: S_OK
1358  *  Failure: Non-zero HRESULT value.
1359  */
1360 HRESULT WINAPI ScriptPlace(HDC hdc, SCRIPT_CACHE *psc, const WORD *pwGlyphs, 
1361                            int cGlyphs, const SCRIPT_VISATTR *psva,
1362                            SCRIPT_ANALYSIS *psa, int *piAdvance, GOFFSET *pGoffset, ABC *pABC )
1363 {
1364     HRESULT hr;
1365     int i;
1366
1367     TRACE("(%p, %p, %p, %d, %p, %p, %p, %p, %p)\n",  hdc, psc, pwGlyphs, cGlyphs, psva, psa,
1368           piAdvance, pGoffset, pABC);
1369
1370     if (!psva) return E_INVALIDARG;
1371     if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1372
1373     if (pABC) memset(pABC, 0, sizeof(ABC));
1374     for (i = 0; i < cGlyphs; i++)
1375     {
1376         ABC abc;
1377         if (!get_cache_glyph_widths(psc, pwGlyphs[i], &abc))
1378         {
1379             if (!hdc) return E_PENDING;
1380             if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE) && !psa->fNoGlyphIndex)
1381             {
1382                 if (!GetCharABCWidthsI(hdc, 0, 1, (WORD *)&pwGlyphs[i], &abc)) return S_FALSE;
1383             }
1384             else
1385             {
1386                 INT width;
1387                 if (!GetCharWidth32W(hdc, pwGlyphs[i], pwGlyphs[i], &width)) return S_FALSE;
1388                 abc.abcB = width;
1389                 abc.abcA = abc.abcC = 0;
1390             }
1391             set_cache_glyph_widths(psc, pwGlyphs[i], &abc);
1392         }
1393         if (pABC)
1394         {
1395             pABC->abcA += abc.abcA;
1396             pABC->abcB += abc.abcB;
1397             pABC->abcC += abc.abcC;
1398         }
1399         /* FIXME: set to more reasonable values */
1400         if (pGoffset)  pGoffset[i].du = pGoffset[i].dv = 0;
1401         if (piAdvance) piAdvance[i] = abc.abcA + abc.abcB + abc.abcC;
1402     }
1403
1404     if (pABC) TRACE("Total for run: abcA=%d, abcB=%d, abcC=%d\n", pABC->abcA, pABC->abcB, pABC->abcC);
1405     return S_OK;
1406 }
1407
1408 /***********************************************************************
1409  *      ScriptGetCMap (USP10.@)
1410  *
1411  * Retrieve glyph indices.
1412  *
1413  * PARAMS
1414  *  hdc         [I]   Device context.
1415  *  psc         [I/O] Opaque pointer to a script cache.
1416  *  pwcInChars  [I]   Array of Unicode characters.
1417  *  cChars      [I]   Number of characters in pwcInChars.
1418  *  dwFlags     [I]   Flags.
1419  *  pwOutGlyphs [O]   Buffer to receive the array of glyph indices.
1420  *
1421  * RETURNS
1422  *  Success: S_OK
1423  *  Failure: Non-zero HRESULT value.
1424  */
1425 HRESULT WINAPI ScriptGetCMap(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcInChars,
1426                              int cChars, DWORD dwFlags, WORD *pwOutGlyphs)
1427 {
1428     HRESULT hr;
1429     int i;
1430
1431     TRACE("(%p,%p,%s,%d,0x%x,%p)\n", hdc, psc, debugstr_wn(pwcInChars, cChars),
1432           cChars, dwFlags, pwOutGlyphs);
1433
1434     if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1435
1436     if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE))
1437     {
1438         for (i = 0; i < cChars; i++)
1439         {
1440             if (!(pwOutGlyphs[i] = get_cache_glyph(psc, pwcInChars[i])))
1441             {
1442                 WORD glyph;
1443                 if (!hdc) return E_PENDING;
1444                 if (GetGlyphIndicesW(hdc, &pwcInChars[i], 1, &glyph, GGI_MARK_NONEXISTING_GLYPHS) == GDI_ERROR) return S_FALSE;
1445                 pwOutGlyphs[i] = set_cache_glyph(psc, pwcInChars[i], glyph);
1446             }
1447         }
1448     }
1449     else
1450     {
1451         TRACE("no glyph translation\n");
1452         for (i = 0; i < cChars; i++) pwOutGlyphs[i] = pwcInChars[i];
1453     }
1454     return S_OK;
1455 }
1456
1457 /***********************************************************************
1458  *      ScriptTextOut (USP10.@)
1459  *
1460  */
1461 HRESULT WINAPI ScriptTextOut(const HDC hdc, SCRIPT_CACHE *psc, int x, int y, UINT fuOptions, 
1462                              const RECT *lprc, const SCRIPT_ANALYSIS *psa, const WCHAR *pwcReserved, 
1463                              int iReserved, const WORD *pwGlyphs, int cGlyphs, const int *piAdvance,
1464                              const int *piJustify, const GOFFSET *pGoffset)
1465 {
1466     HRESULT hr = S_OK;
1467
1468     TRACE("(%p, %p, %d, %d, %04x, %p, %p, %p, %d, %p, %d, %p, %p, %p)\n",
1469          hdc, psc, x, y, fuOptions, lprc, psa, pwcReserved, iReserved, pwGlyphs, cGlyphs,
1470          piAdvance, piJustify, pGoffset);
1471
1472     if (!hdc || !psc) return E_INVALIDARG;
1473     if (!piAdvance || !psa || !pwGlyphs) return E_INVALIDARG;
1474
1475     fuOptions &= ETO_CLIPPED + ETO_OPAQUE;
1476     if  (!psa->fNoGlyphIndex)                                     /* Have Glyphs?                      */
1477         fuOptions |= ETO_GLYPH_INDEX;                             /* Say don't do translation to glyph */
1478
1479     if (!ExtTextOutW(hdc, x, y, fuOptions, lprc, pwGlyphs, cGlyphs, NULL))
1480         hr = S_FALSE;
1481
1482     return hr;
1483 }
1484
1485 /***********************************************************************
1486  *      ScriptCacheGetHeight (USP10.@)
1487  *
1488  * Retrieve the height of the font in the cache.
1489  *
1490  * PARAMS
1491  *  hdc    [I]    Device context.
1492  *  psc    [I/O]  Opaque pointer to a script cache.
1493  *  height [O]    Receives font height.
1494  *
1495  * RETURNS
1496  *  Success: S_OK
1497  *  Failure: Non-zero HRESULT value.
1498  */
1499 HRESULT WINAPI ScriptCacheGetHeight(HDC hdc, SCRIPT_CACHE *psc, LONG *height)
1500 {
1501     HRESULT hr;
1502
1503     TRACE("(%p, %p, %p)\n", hdc, psc, height);
1504
1505     if (!height) return E_INVALIDARG;
1506     if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1507
1508     *height = get_cache_height(psc);
1509     return S_OK;
1510 }
1511
1512 /***********************************************************************
1513  *      ScriptGetGlyphABCWidth (USP10.@)
1514  *
1515  * Retrieve the width of a glyph.
1516  *
1517  * PARAMS
1518  *  hdc    [I]    Device context.
1519  *  psc    [I/O]  Opaque pointer to a script cache.
1520  *  glyph  [I]    Glyph to retrieve the width for.
1521  *  abc    [O]    ABC widths of the glyph.
1522  *
1523  * RETURNS
1524  *  Success: S_OK
1525  *  Failure: Non-zero HRESULT value.
1526  */
1527 HRESULT WINAPI ScriptGetGlyphABCWidth(HDC hdc, SCRIPT_CACHE *psc, WORD glyph, ABC *abc)
1528 {
1529     HRESULT hr;
1530
1531     TRACE("(%p, %p, 0x%04x, %p)\n", hdc, psc, glyph, abc);
1532
1533     if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1534
1535     if (!get_cache_glyph_widths(psc, glyph, abc))
1536     {
1537         if (!hdc) return E_PENDING;
1538         if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE))
1539         {
1540             if (!GetCharABCWidthsI(hdc, 0, 1, &glyph, abc)) return S_FALSE;
1541         }
1542         else
1543         {
1544             INT width;
1545             if (!GetCharWidth32W(hdc, glyph, glyph, &width)) return S_FALSE;
1546             abc->abcB = width;
1547             abc->abcA = abc->abcC = 0;
1548         }
1549         set_cache_glyph_widths(psc, glyph, abc);
1550     }
1551     return S_OK;
1552 }
1553
1554 /***********************************************************************
1555  *      ScriptLayout (USP10.@)
1556  *
1557  * Map embedding levels to visual and/or logical order.
1558  *
1559  * PARAMS
1560  *  runs     [I] Size of level array.
1561  *  level    [I] Array of embedding levels.
1562  *  vistolog [O] Map of embedding levels from visual to logical order.
1563  *  logtovis [O] Map of embedding levels from logical to visual order.
1564  *
1565  * RETURNS
1566  *  Success: S_OK
1567  *  Failure: Non-zero HRESULT value.
1568  *
1569  * BUGS
1570  *  This stub works correctly for any sequence of a single
1571  *  embedding level but not for sequences of different
1572  *  embedding levels, i.e. mixtures of RTL and LTR scripts.
1573  */
1574 HRESULT WINAPI ScriptLayout(int runs, const BYTE *level, int *vistolog, int *logtovis)
1575 {
1576     int i, j = runs - 1, k = 0;
1577
1578     TRACE("(%d, %p, %p, %p)\n", runs, level, vistolog, logtovis);
1579
1580     if (!level || (!vistolog && !logtovis))
1581         return E_INVALIDARG;
1582
1583     for (i = 0; i < runs; i++)
1584     {
1585         if (level[i] % 2)
1586         {
1587             if (vistolog) *vistolog++ = j;
1588             if (logtovis) *logtovis++ = j;
1589             j--;
1590         }
1591         else
1592         {
1593             if (vistolog) *vistolog++ = k;
1594             if (logtovis) *logtovis++ = k;
1595             k++;
1596         }
1597     }
1598     return S_OK;
1599 }
1600
1601 /***********************************************************************
1602  *      ScriptStringGetLogicalWidths (USP10.@)
1603  *
1604  * Returns logical widths from a string analysis.
1605  *
1606  * PARAMS
1607  *  ssa  [I] string analysis.
1608  *  piDx [O] logical widths returned.
1609  *
1610  * RETURNS
1611  *  Success: S_OK
1612  *  Failure: a non-zero HRESULT.
1613  */
1614 HRESULT WINAPI ScriptStringGetLogicalWidths(SCRIPT_STRING_ANALYSIS ssa, int *piDx)
1615 {
1616     int i, j, next = 0;
1617     StringAnalysis *analysis = ssa;
1618
1619     TRACE("%p, %p\n", ssa, piDx);
1620
1621     if (!analysis) return S_FALSE;
1622
1623     for (i = 0; i < analysis->numItems; i++)
1624     {
1625         for (j = 0; j < analysis->glyphs[i].numGlyphs; j++)
1626         {
1627             piDx[next] = analysis->glyphs[i].piAdvance[j];
1628             next++;
1629         }
1630     }
1631     return S_OK;
1632 }
1633
1634 /***********************************************************************
1635  *      ScriptStringValidate (USP10.@)
1636  *
1637  * Validate a string analysis.
1638  *
1639  * PARAMS
1640  *  ssa [I] string analysis.
1641  *
1642  * RETURNS
1643  *  Success: S_OK
1644  *  Failure: S_FALSE if invalid sequences are found
1645  *           or a non-zero HRESULT if it fails.
1646  */
1647 HRESULT WINAPI ScriptStringValidate(SCRIPT_STRING_ANALYSIS ssa)
1648 {
1649     StringAnalysis *analysis = ssa;
1650
1651     TRACE("(%p)\n", ssa);
1652
1653     if (!analysis) return E_INVALIDARG;
1654     return (analysis->invalid) ? S_FALSE : S_OK;
1655 }
1656
1657 /***********************************************************************
1658  *      ScriptString_pSize (USP10.@)
1659  *
1660  * Retrieve width and height of an analysed string.
1661  *
1662  * PARAMS
1663  *  ssa [I] string analysis.
1664  *
1665  * RETURNS
1666  *  Success: Pointer to a SIZE structure.
1667  *  Failure: NULL
1668  */
1669 const SIZE * WINAPI ScriptString_pSize(SCRIPT_STRING_ANALYSIS ssa)
1670 {
1671     int i, j;
1672     StringAnalysis *analysis = ssa;
1673
1674     TRACE("(%p)\n", ssa);
1675
1676     if (!analysis) return NULL;
1677
1678     if (!analysis->sz)
1679     {
1680         if (!(analysis->sz = heap_alloc(sizeof(SIZE)))) return NULL;
1681         analysis->sz->cy = analysis->sc->tm.tmHeight;
1682
1683         analysis->sz->cx = 0;
1684         for (i = 0; i < analysis->numItems; i++)
1685             for (j = 0; j < analysis->glyphs[i].numGlyphs; j++)
1686                 analysis->sz->cx += analysis->glyphs[i].piAdvance[j];
1687     }
1688     return analysis->sz;
1689 }
1690
1691 /***********************************************************************
1692  *      ScriptString_pLogAttr (USP10.@)
1693  *
1694  * Retrieve logical attributes of an analysed string.
1695  *
1696  * PARAMS
1697  *  ssa [I] string analysis.
1698  *
1699  * RETURNS
1700  *  Success: Pointer to an array of SCRIPT_LOGATTR structures.
1701  *  Failure: NULL
1702  */
1703 const SCRIPT_LOGATTR * WINAPI ScriptString_pLogAttr(SCRIPT_STRING_ANALYSIS ssa)
1704 {
1705     StringAnalysis *analysis = ssa;
1706
1707     TRACE("(%p)\n", ssa);
1708
1709     if (!analysis) return NULL;
1710     return analysis->logattrs;
1711 }
1712
1713 /***********************************************************************
1714  *      ScriptString_pcOutChars (USP10.@)
1715  *
1716  * Retrieve the length of a string after clipping.
1717  *
1718  * PARAMS
1719  *  ssa [I] String analysis.
1720  *
1721  * RETURNS
1722  *  Success: Pointer to the length.
1723  *  Failure: NULL
1724  */
1725 const int * WINAPI ScriptString_pcOutChars(SCRIPT_STRING_ANALYSIS ssa)
1726 {
1727     StringAnalysis *analysis = ssa;
1728
1729     TRACE("(%p)\n", ssa);
1730
1731     if (!analysis) return NULL;
1732     return &analysis->clip_len;
1733 }
1734
1735 /***********************************************************************
1736  *      ScriptStringGetOrder (USP10.@)
1737  *
1738  * Retrieve a glyph order map.
1739  *
1740  * PARAMS
1741  *  ssa   [I]   String analysis.
1742  *  order [I/O] Array of glyph positions.
1743  *
1744  * RETURNS
1745  *  Success: S_OK
1746  *  Failure: a non-zero HRESULT.
1747  */
1748 HRESULT WINAPI ScriptStringGetOrder(SCRIPT_STRING_ANALYSIS ssa, UINT *order)
1749 {
1750     int i, j;
1751     unsigned int k;
1752     StringAnalysis *analysis = ssa;
1753
1754     TRACE("(%p)\n", ssa);
1755
1756     if (!analysis) return S_FALSE;
1757
1758     /* FIXME: handle RTL scripts */
1759     for (i = 0, k = 0; i < analysis->numItems; i++)
1760         for (j = 0; j < analysis->glyphs[i].numGlyphs; j++, k++)
1761             order[k] = k;
1762
1763     return S_OK;
1764 }
1765
1766 /***********************************************************************
1767  *      ScriptGetLogicalWidths (USP10.@)
1768  *
1769  * Convert advance widths to logical widths.
1770  *
1771  * PARAMS
1772  *  sa          [I] Script analysis.
1773  *  nbchars     [I] Number of characters.
1774  *  nbglyphs    [I] Number of glyphs.
1775  *  glyph_width [I] Array of glyph widths.
1776  *  log_clust   [I] Array of logical clusters.
1777  *  sva         [I] Visual attributes.
1778  *  widths      [O] Array of logical widths.
1779  *
1780  * RETURNS
1781  *  Success: S_OK
1782  *  Failure: a non-zero HRESULT.
1783  */
1784 HRESULT WINAPI ScriptGetLogicalWidths(const SCRIPT_ANALYSIS *sa, int nbchars, int nbglyphs,
1785                                       const int *glyph_width, const WORD *log_clust,
1786                                       const SCRIPT_VISATTR *sva, int *widths)
1787 {
1788     int i;
1789
1790     TRACE("(%p, %d, %d, %p, %p, %p, %p)\n",
1791           sa, nbchars, nbglyphs, glyph_width, log_clust, sva, widths);
1792
1793     /* FIXME */
1794     for (i = 0; i < nbchars; i++) widths[i] = glyph_width[i];
1795     return S_OK;
1796 }