shdoclc: Remove a space before an ellipsis in the Italian translation.
[wine/hramrach.git] / dlls / usp10 / usp10.c
blob29ec1e8b0e3d48385c43ce7147b9b6822189b80e
1 /*
2 * Implementation of Uniscribe Script Processor (usp10.dll)
4 * Copyright 2005 Steven Edwards for CodeWeavers
5 * Copyright 2006 Hans Leidekker
6 * Copyright 2010 CodeWeavers, Aric Stewart
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 * Notes:
23 * Uniscribe allows for processing of complex scripts such as joining
24 * and filtering characters and bi-directional text with custom line breaks.
27 #include <stdarg.h>
29 #include "windef.h"
30 #include "winbase.h"
31 #include "wingdi.h"
32 #include "winuser.h"
33 #include "winnls.h"
34 #include "usp10.h"
36 #include "usp10_internal.h"
38 #include "wine/debug.h"
39 #include "wine/unicode.h"
41 WINE_DEFAULT_DEBUG_CHANNEL(uniscribe);
43 typedef struct _scriptRange
45 WORD script;
46 WORD rangeFirst;
47 WORD rangeLast;
48 WORD numericScript;
49 WORD punctScript;
50 } scriptRange;
52 static const scriptRange scriptRanges[] = {
53 /* Basic Latin: U+0000–U+007A */
54 /* Latin-1 Supplement: U+0080–U+00FF */
55 /* Latin Extended-A: U+0100–U+017F */
56 /* Latin Extended-B: U+0180–U+024F */
57 /* IPA Extensions: U+0250–U+02AF */
58 { Script_Latin, 0x00, 0x2af , Script_Numeric, Script_Punctuation},
59 /* Greek: U+0370–U+03FF */
60 { Script_Greek, 0x370, 0x3ff, 0, 0},
61 /* Cyrillic: U+0400–U+04FF */
62 /* Cyrillic Supplement: U+0500–U+052F */
63 { Script_Cyrillic, 0x400, 0x52f, 0, 0},
64 /* Armenian: U+0530–U+058F */
65 { Script_Armenian, 0x530, 0x58f, 0, 0},
66 /* Hebrew: U+0590–U+05FF */
67 { Script_Hebrew, 0x590, 0x5ff, 0, 0},
68 /* Arabic: U+0600–U+06FF */
69 { Script_Arabic, 0x600, 0x6ef, Script_Arabic_Numeric, 0},
70 /* Defined by Windows */
71 { Script_Persian, 0x6f0, 0x6f9, 0, 0},
72 /* Continue Arabic: U+0600–U+06FF */
73 { Script_Arabic, 0x6fa, 0x6ff, 0, 0},
74 /* Syriac: U+0700–U+074F*/
75 { Script_Syriac, 0x700, 0x74f, 0, 0},
76 /* Arabic Supplement: U+0750–U+077F */
77 { Script_Arabic, 0x750, 0x77f, 0, 0},
78 /* Thaana: U+0780–U+07BF */
79 { Script_Thaana, 0x780, 0x7bf, 0, 0},
80 /* Sinhala: U+0D80–U+0DFF */
81 { Script_Sinhala, 0xd80, 0xdff, 0, 0},
82 /* Thai: U+0E00–U+0E7F */
83 { Script_Thai, 0xe00, 0xe7f, Script_Thai_Numeric, 0},
84 /* Lao: U+0E80–U+0EFF */
85 { Script_Lao, 0xe80, 0xeff, Script_Lao_Numeric, 0},
86 /* Tibetan: U+0F00–U+0FFF */
87 { Script_Tibetan, 0xf00, 0xfff, Script_Tibetan_Numeric, 0},
88 /* Georgian: U+10A0–U+10FF */
89 { Script_Georgian, 0x10a0, 0x10ff, 0, 0},
90 /* Phonetic Extensions: U+1D00–U+1DBF */
91 { Script_Latin, 0x1d00, 0x1dbf, 0, 0},
92 /* Latin Extended Additional: U+1E00–U+1EFF */
93 { Script_Latin, 0x1e00, 0x1eff, 0, 0},
94 /* Greek Extended: U+1F00–U+1FFF */
95 { Script_Greek, 0x1f00, 0x1fff, 0, 0},
96 /* Latin Extended-C: U+2C60–U+2C7F */
97 { Script_Latin, 0x2c60, 0x2c7f, 0, 0},
98 /* Georgian: U+2D00–U+2D2F */
99 { Script_Georgian, 0x2d00, 0x2d2f, 0, 0},
100 /* Cyrillic Extended-A: U+2DE0–U+2DFF */
101 { Script_Cyrillic, 0x2de0, 0x2dff, 0, 0},
102 /* Cyrillic Extended-B: U+A640–U+A69F */
103 { Script_Cyrillic, 0xa640, 0xa69f, 0, 0},
104 /* Modifier Tone Letters: U+A700–U+A71F */
105 /* Latin Extended-D: U+A720–U+A7FF */
106 { Script_Latin, 0xa700, 0xa7ff, 0, 0},
107 /* Phags-pa: U+A840–U+A87F */
108 { Script_Phags_pa, 0xa840, 0xa87f, 0, 0},
109 /* Latin Ligatures: U+FB00–U+FB06 */
110 { Script_Latin, 0xfb00, 0xfb06, 0, 0},
111 /* Armenian ligatures U+FB13..U+FB17 */
112 { Script_Armenian, 0xfb13, 0xfb17, 0, 0},
113 /* Alphabetic Presentation Forms: U+FB1D–U+FB4F */
114 { Script_Hebrew, 0xfb1d, 0xfb4f, 0, 0},
115 /* Arabic Presentation Forms-A: U+FB50–U+FDFF*/
116 { Script_Arabic, 0xfb50, 0xfdff, 0, 0},
117 /* Arabic Presentation Forms-B: U+FE70–U+FEFF*/
118 { Script_Arabic, 0xfe70, 0xfeff, 0, 0},
119 /* END */
120 { SCRIPT_UNDEFINED, 0, 0, 0}
123 typedef struct _scriptData
125 SCRIPT_ANALYSIS a;
126 SCRIPT_PROPERTIES props;
127 } scriptData;
129 /* the must be in order so that the index matches the Script value */
130 static const scriptData scriptInformation[] = {
131 {{SCRIPT_UNDEFINED, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
132 {LANG_NEUTRAL, 0, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
133 {{Script_Latin, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
134 {LANG_ENGLISH, 0, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 1, 0, 0}},
135 {{Script_CR, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
136 {LANG_NEUTRAL, 0, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
137 {{Script_Numeric, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
138 {LANG_ENGLISH, 1, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
139 {{Script_Control, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
140 {LANG_ENGLISH, 0, 1, 0, 0, ANSI_CHARSET, 1, 0, 0, 0, 0, 0, 1, 0, 0}},
141 {{Script_Punctuation, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
142 {LANG_NEUTRAL, 0, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
143 {{Script_Arabic, 1, 1, 0, 0, 0, 0, { 1,0,0,0,0,0,0,0,0,0,0}},
144 {LANG_ARABIC, 0, 1, 0, 0, ARABIC_CHARSET, 0, 0, 0, 0, 0, 0, 1, 1, 0}},
145 {{Script_Arabic_Numeric, 1, 1, 0, 0, 0, 0, { 1,0,0,0,0,0,0,0,0,0,0}},
146 {LANG_ARABIC, 1, 1, 0, 0, ARABIC_CHARSET, 0, 0, 0, 0, 0, 0, 1, 0, 0}},
147 {{Script_Hebrew, 1, 1, 0, 0, 0, 0, { 1,0,0,0,0,0,0,0,0,0,0}},
148 {LANG_HEBREW, 0, 1, 0, 1, HEBREW_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
149 {{Script_Syriac, 1, 1, 0, 0, 0, 0, { 1,0,0,0,0,0,0,0,0,0,0}},
150 {LANG_SYRIAC, 0, 1, 0, 0, DEFAULT_CHARSET, 0, 0, 0, 0, 1, 0, 0, 1, 0}},
151 {{Script_Persian, 1, 1, 0, 0, 0, 0, { 1,0,0,0,0,0,0,0,0,0,0}},
152 {LANG_PERSIAN, 1, 1, 0, 0, ARABIC_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
153 {{Script_Thaana, 1, 1, 0, 0, 0, 0, { 1,0,0,0,0,0,0,0,0,0,0}},
154 {LANG_DIVEHI, 0, 1, 0, 1, DEFAULT_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
155 {{Script_Greek, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
156 {LANG_GREEK, 0, 0, 0, 0, GREEK_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
157 {{Script_Cyrillic, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
158 {LANG_RUSSIAN, 0, 0, 0, 0, RUSSIAN_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
159 {{Script_Armenian, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
160 {LANG_ARMENIAN, 0, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 1, 0, 0}},
161 {{Script_Georgian, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
162 {LANG_GEORGIAN, 0, 0, 0, 0, ANSI_CHARSET, 0, 0, 0, 0, 0, 0, 1, 0, 0}},
163 {{Script_Sinhala, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
164 {LANG_SINHALESE, 0, 1, 0, 1, DEFAULT_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
165 {{Script_Tibetan, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
166 {LANG_TIBETAN, 0, 1, 1, 1, DEFAULT_CHARSET, 0, 0, 1, 0, 1, 0, 0, 0, 0}},
167 {{Script_Tibetan_Numeric, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
168 {LANG_TIBETAN, 1, 1, 0, 0, DEFAULT_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
169 {{Script_Phags_pa, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
170 {LANG_MONGOLIAN, 0, 1, 0, 0, DEFAULT_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
171 {{Script_Thai, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
172 {LANG_THAI, 0, 1, 1, 1, THAI_CHARSET, 0, 0, 1, 0, 1, 0, 0, 0, 1}},
173 {{Script_Thai_Numeric, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
174 {LANG_THAI, 1, 1, 0, 0, THAI_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
175 {{Script_Lao, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
176 {LANG_LAO, 0, 1, 1, 1, DEFAULT_CHARSET, 0, 0, 1, 0, 1, 0, 0, 0, 0}},
177 {{Script_Lao_Numeric, 0, 0, 0, 0, 0, 0, { 0,0,0,0,0,0,0,0,0,0,0}},
178 {LANG_LAO, 1, 1, 0, 0, DEFAULT_CHARSET, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
181 static const SCRIPT_PROPERTIES *script_props[] =
183 &scriptInformation[0].props, &scriptInformation[1].props,
184 &scriptInformation[2].props, &scriptInformation[3].props,
185 &scriptInformation[4].props, &scriptInformation[5].props,
186 &scriptInformation[6].props, &scriptInformation[7].props,
187 &scriptInformation[8].props, &scriptInformation[9].props,
188 &scriptInformation[10].props, &scriptInformation[11].props,
189 &scriptInformation[12].props, &scriptInformation[13].props,
190 &scriptInformation[14].props, &scriptInformation[15].props,
191 &scriptInformation[16].props, &scriptInformation[17].props,
192 &scriptInformation[18].props, &scriptInformation[19].props,
193 &scriptInformation[20].props, &scriptInformation[21].props,
194 &scriptInformation[22].props, &scriptInformation[23].props
197 typedef struct {
198 int numGlyphs;
199 WORD* glyphs;
200 WORD* pwLogClust;
201 int* piAdvance;
202 SCRIPT_VISATTR* psva;
203 GOFFSET* pGoffset;
204 ABC* abc;
205 } StringGlyphs;
207 typedef struct {
208 HDC hdc;
209 BOOL invalid;
210 int clip_len;
211 ScriptCache *sc;
212 int cItems;
213 int cMaxGlyphs;
214 SCRIPT_ITEM* pItem;
215 int numItems;
216 StringGlyphs* glyphs;
217 SCRIPT_LOGATTR* logattrs;
218 SIZE* sz;
219 } StringAnalysis;
221 static inline void *heap_alloc(SIZE_T size)
223 return HeapAlloc(GetProcessHeap(), 0, size);
226 static inline void *heap_alloc_zero(SIZE_T size)
228 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
231 static inline void *heap_realloc_zero(LPVOID mem, SIZE_T size)
233 return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size);
236 static inline BOOL heap_free(LPVOID mem)
238 return HeapFree(GetProcessHeap(), 0, mem);
241 static inline WCHAR get_cache_default_char(SCRIPT_CACHE *psc)
243 return ((ScriptCache *)*psc)->tm.tmDefaultChar;
246 static inline LONG get_cache_height(SCRIPT_CACHE *psc)
248 return ((ScriptCache *)*psc)->tm.tmHeight;
251 static inline BYTE get_cache_pitch_family(SCRIPT_CACHE *psc)
253 return ((ScriptCache *)*psc)->tm.tmPitchAndFamily;
256 static inline WORD get_cache_glyph(SCRIPT_CACHE *psc, WCHAR c)
258 WORD *block = ((ScriptCache *)*psc)->glyphs[c >> GLYPH_BLOCK_SHIFT];
260 if (!block) return 0;
261 return block[c & GLYPH_BLOCK_MASK];
264 static inline WORD set_cache_glyph(SCRIPT_CACHE *psc, WCHAR c, WORD glyph)
266 WORD **block = &((ScriptCache *)*psc)->glyphs[c >> GLYPH_BLOCK_SHIFT];
268 if (!*block && !(*block = heap_alloc_zero(sizeof(WORD) * GLYPH_BLOCK_SIZE))) return 0;
269 return ((*block)[c & GLYPH_BLOCK_MASK] = glyph);
272 static inline BOOL get_cache_glyph_widths(SCRIPT_CACHE *psc, WORD glyph, ABC *abc)
274 static const ABC nil;
275 ABC *block = ((ScriptCache *)*psc)->widths[glyph >> GLYPH_BLOCK_SHIFT];
277 if (!block || !memcmp(&block[glyph & GLYPH_BLOCK_MASK], &nil, sizeof(ABC))) return FALSE;
278 memcpy(abc, &block[glyph & GLYPH_BLOCK_MASK], sizeof(ABC));
279 return TRUE;
282 static inline BOOL set_cache_glyph_widths(SCRIPT_CACHE *psc, WORD glyph, ABC *abc)
284 ABC **block = &((ScriptCache *)*psc)->widths[glyph >> GLYPH_BLOCK_SHIFT];
286 if (!*block && !(*block = heap_alloc_zero(sizeof(ABC) * GLYPH_BLOCK_SIZE))) return FALSE;
287 memcpy(&(*block)[glyph & GLYPH_BLOCK_MASK], abc, sizeof(ABC));
288 return TRUE;
291 static HRESULT init_script_cache(const HDC hdc, SCRIPT_CACHE *psc)
293 ScriptCache *sc;
295 if (!psc) return E_INVALIDARG;
296 if (*psc) return S_OK;
297 if (!hdc) return E_PENDING;
299 if (!(sc = heap_alloc_zero(sizeof(ScriptCache)))) return E_OUTOFMEMORY;
300 if (!GetTextMetricsW(hdc, &sc->tm))
302 heap_free(sc);
303 return E_INVALIDARG;
305 if (!GetObjectW(GetCurrentObject(hdc, OBJ_FONT), sizeof(LOGFONTW), &sc->lf))
307 heap_free(sc);
308 return E_INVALIDARG;
310 *psc = sc;
311 TRACE("<- %p\n", sc);
312 return S_OK;
315 static WCHAR mirror_char( WCHAR ch )
317 extern const WCHAR wine_mirror_map[];
318 return ch + wine_mirror_map[wine_mirror_map[ch >> 8] + (ch & 0xff)];
321 static WORD get_char_script( WCHAR ch)
323 WORD type = 0;
324 int i;
326 if (ch == 0xc || ch == 0x20 || ch == 0x202f)
327 return Script_CR;
329 GetStringTypeW(CT_CTYPE1, &ch, 1, &type);
331 if (type == 0)
332 return SCRIPT_UNDEFINED;
334 if (type & C1_CNTRL)
335 return Script_Control;
337 i = 0;
340 if (ch < scriptRanges[i].rangeFirst || scriptRanges[i].script == SCRIPT_UNDEFINED)
341 break;
343 if (ch >= scriptRanges[i].rangeFirst && ch <= scriptRanges[i].rangeLast)
345 if (scriptRanges[i].numericScript && type & C1_DIGIT)
346 return scriptRanges[i].numericScript;
347 if (scriptRanges[i].punctScript && type & C1_PUNCT)
348 return scriptRanges[i].punctScript;
349 return scriptRanges[i].script;
351 i++;
352 } while (1);
354 return SCRIPT_UNDEFINED;
357 /***********************************************************************
358 * DllMain
361 BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID lpv)
363 switch(fdwReason)
365 case DLL_PROCESS_ATTACH:
366 DisableThreadLibraryCalls(hInstDLL);
367 break;
368 case DLL_PROCESS_DETACH:
369 break;
371 return TRUE;
374 /***********************************************************************
375 * ScriptFreeCache (USP10.@)
377 * Free a script cache.
379 * PARAMS
380 * psc [I/O] Script cache.
382 * RETURNS
383 * Success: S_OK
384 * Failure: Non-zero HRESULT value.
386 HRESULT WINAPI ScriptFreeCache(SCRIPT_CACHE *psc)
388 TRACE("%p\n", psc);
390 if (psc && *psc)
392 unsigned int i;
393 for (i = 0; i < GLYPH_MAX / GLYPH_BLOCK_SIZE; i++)
395 heap_free(((ScriptCache *)*psc)->glyphs[i]);
396 heap_free(((ScriptCache *)*psc)->widths[i]);
398 heap_free(((ScriptCache *)*psc)->GSUB_Table);
399 heap_free(((ScriptCache *)*psc)->features);
400 heap_free(*psc);
401 *psc = NULL;
403 return S_OK;
406 /***********************************************************************
407 * ScriptGetProperties (USP10.@)
409 * Retrieve a list of script properties.
411 * PARAMS
412 * props [I] Pointer to an array of SCRIPT_PROPERTIES pointers.
413 * num [I] Pointer to the number of scripts.
415 * RETURNS
416 * Success: S_OK
417 * Failure: Non-zero HRESULT value.
419 * NOTES
420 * Behaviour matches WinXP.
422 HRESULT WINAPI ScriptGetProperties(const SCRIPT_PROPERTIES ***props, int *num)
424 TRACE("(%p,%p)\n", props, num);
426 if (!props && !num) return E_INVALIDARG;
428 if (num) *num = sizeof(script_props)/sizeof(script_props[0]);
429 if (props) *props = script_props;
431 return S_OK;
434 /***********************************************************************
435 * ScriptGetFontProperties (USP10.@)
437 * Get information on special glyphs.
439 * PARAMS
440 * hdc [I] Device context.
441 * psc [I/O] Opaque pointer to a script cache.
442 * sfp [O] Font properties structure.
444 HRESULT WINAPI ScriptGetFontProperties(HDC hdc, SCRIPT_CACHE *psc, SCRIPT_FONTPROPERTIES *sfp)
446 HRESULT hr;
448 TRACE("%p,%p,%p\n", hdc, psc, sfp);
450 if (!sfp) return E_INVALIDARG;
451 if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
453 if (sfp->cBytes != sizeof(SCRIPT_FONTPROPERTIES))
454 return E_INVALIDARG;
456 /* return something sensible? */
457 sfp->wgBlank = 0;
458 sfp->wgDefault = get_cache_default_char(psc);
459 sfp->wgInvalid = 0;
460 sfp->wgKashida = 0xffff;
461 sfp->iKashidaWidth = 0;
463 return S_OK;
466 /***********************************************************************
467 * ScriptRecordDigitSubstitution (USP10.@)
469 * Record digit substitution settings for a given locale.
471 * PARAMS
472 * locale [I] Locale identifier.
473 * sds [I] Structure to record substitution settings.
475 * RETURNS
476 * Success: S_OK
477 * Failure: E_POINTER if sds is NULL, E_INVALIDARG otherwise.
479 * SEE ALSO
480 * http://blogs.msdn.com/michkap/archive/2006/02/22/536877.aspx
482 HRESULT WINAPI ScriptRecordDigitSubstitution(LCID locale, SCRIPT_DIGITSUBSTITUTE *sds)
484 DWORD plgid, sub;
486 TRACE("0x%x, %p\n", locale, sds);
488 /* This implementation appears to be correct for all languages, but it's
489 * not clear if sds->DigitSubstitute is ever set to anything except
490 * CONTEXT or NONE in reality */
492 if (!sds) return E_POINTER;
494 locale = ConvertDefaultLocale(locale);
496 if (!IsValidLocale(locale, LCID_INSTALLED))
497 return E_INVALIDARG;
499 plgid = PRIMARYLANGID(LANGIDFROMLCID(locale));
500 sds->TraditionalDigitLanguage = plgid;
502 if (plgid == LANG_ARABIC || plgid == LANG_FARSI)
503 sds->NationalDigitLanguage = plgid;
504 else
505 sds->NationalDigitLanguage = LANG_ENGLISH;
507 if (!GetLocaleInfoW(locale, LOCALE_IDIGITSUBSTITUTION | LOCALE_RETURN_NUMBER,
508 (LPWSTR)&sub, sizeof(sub)/sizeof(WCHAR))) return E_INVALIDARG;
510 switch (sub)
512 case 0:
513 if (plgid == LANG_ARABIC || plgid == LANG_FARSI)
514 sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_CONTEXT;
515 else
516 sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_NONE;
517 break;
518 case 1:
519 sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_NONE;
520 break;
521 case 2:
522 sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_NATIONAL;
523 break;
524 default:
525 sds->DigitSubstitute = SCRIPT_DIGITSUBSTITUTE_TRADITIONAL;
526 break;
529 sds->dwReserved = 0;
530 return S_OK;
533 /***********************************************************************
534 * ScriptApplyDigitSubstitution (USP10.@)
536 * Apply digit substitution settings.
538 * PARAMS
539 * sds [I] Structure with recorded substitution settings.
540 * sc [I] Script control structure.
541 * ss [I] Script state structure.
543 * RETURNS
544 * Success: S_OK
545 * Failure: E_INVALIDARG if sds is invalid. Otherwise an HRESULT.
547 HRESULT WINAPI ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE *sds,
548 SCRIPT_CONTROL *sc, SCRIPT_STATE *ss)
550 SCRIPT_DIGITSUBSTITUTE psds;
552 TRACE("%p, %p, %p\n", sds, sc, ss);
554 if (!sc || !ss) return E_POINTER;
555 if (!sds)
557 sds = &psds;
558 if (ScriptRecordDigitSubstitution(LOCALE_USER_DEFAULT, &psds) != S_OK)
559 return E_INVALIDARG;
562 sc->uDefaultLanguage = LANG_ENGLISH;
563 sc->fContextDigits = 0;
564 ss->fDigitSubstitute = 0;
566 switch (sds->DigitSubstitute) {
567 case SCRIPT_DIGITSUBSTITUTE_CONTEXT:
568 case SCRIPT_DIGITSUBSTITUTE_NATIONAL:
569 case SCRIPT_DIGITSUBSTITUTE_NONE:
570 case SCRIPT_DIGITSUBSTITUTE_TRADITIONAL:
571 return S_OK;
572 default:
573 return E_INVALIDARG;
577 /***********************************************************************
578 * ScriptItemize (USP10.@)
580 * Split a Unicode string into shapeable parts.
582 * PARAMS
583 * pwcInChars [I] String to split.
584 * cInChars [I] Number of characters in pwcInChars.
585 * cMaxItems [I] Maximum number of items to return.
586 * psControl [I] Pointer to a SCRIPT_CONTROL structure.
587 * psState [I] Pointer to a SCRIPT_STATE structure.
588 * pItems [O] Buffer to receive SCRIPT_ITEM structures.
589 * pcItems [O] Number of script items returned.
591 * RETURNS
592 * Success: S_OK
593 * Failure: Non-zero HRESULT value.
595 HRESULT WINAPI ScriptItemize(const WCHAR *pwcInChars, int cInChars, int cMaxItems,
596 const SCRIPT_CONTROL *psControl, const SCRIPT_STATE *psState,
597 SCRIPT_ITEM *pItems, int *pcItems)
600 #define Numeric_space 0x0020
602 int cnt = 0, index = 0;
603 int New_Script = SCRIPT_UNDEFINED;
604 WORD *levels = NULL;
605 WORD baselevel = 0;
607 TRACE("%s,%d,%d,%p,%p,%p,%p\n", debugstr_wn(pwcInChars, cInChars), cInChars, cMaxItems,
608 psControl, psState, pItems, pcItems);
610 if (!pwcInChars || !cInChars || !pItems || cMaxItems < 2)
611 return E_INVALIDARG;
613 if (psState && psControl)
615 int i;
616 levels = heap_alloc_zero(cInChars * sizeof(WORD));
617 if (!levels)
618 return E_OUTOFMEMORY;
620 BIDI_DetermineLevels(pwcInChars, cInChars, psState, psControl, levels);
621 baselevel = levels[0];
622 for (i = 0; i < cInChars; i++)
623 if (levels[i]!=levels[0])
624 break;
625 if (i >= cInChars)
627 heap_free(levels);
628 levels = NULL;
632 pItems[index].iCharPos = 0;
633 pItems[index].a = scriptInformation[get_char_script(pwcInChars[cnt])].a;
635 if (levels)
637 pItems[index].a.fRTL = odd(levels[cnt]);
638 pItems[index].a.fLayoutRTL = odd(levels[cnt]);
639 pItems[index].a.s.uBidiLevel = levels[cnt];
641 else if (!pItems[index].a.s.uBidiLevel)
643 pItems[index].a.s.uBidiLevel = baselevel;
644 pItems[index].a.fLayoutRTL = odd(baselevel);
645 pItems[index].a.fRTL = odd(baselevel);
648 TRACE("New_Level=%i New_Script=%d, eScript=%d index=%d cnt=%d iCharPos=%d\n",
649 levels?levels[cnt]:-1, New_Script, pItems[index].a.eScript, index, cnt,
650 pItems[index].iCharPos);
652 for (cnt=1; cnt < cInChars; cnt++)
654 if (levels && (levels[cnt] == pItems[index].a.s.uBidiLevel))
655 continue;
657 if(pwcInChars[cnt] != Numeric_space)
658 New_Script = get_char_script(pwcInChars[cnt]);
660 if ((levels && (levels[cnt] != pItems[index].a.s.uBidiLevel)) || New_Script != pItems[index].a.eScript || New_Script == Script_Control)
662 TRACE("New_Level = %i, New_Script=%d, eScript=%d ", levels?levels[cnt]:-1, New_Script, pItems[index].a.eScript);
663 index++;
664 if (index+1 > cMaxItems)
665 return E_OUTOFMEMORY;
667 pItems[index].iCharPos = cnt;
668 memset(&pItems[index].a, 0, sizeof(SCRIPT_ANALYSIS));
670 pItems[index].a = scriptInformation[New_Script].a;
671 if (levels)
673 pItems[index].a.fRTL = odd(levels[cnt]);
674 pItems[index].a.fLayoutRTL = odd(levels[cnt]);
675 pItems[index].a.s.uBidiLevel = levels[cnt];
677 else if (!pItems[index].a.s.uBidiLevel)
679 pItems[index].a.s.uBidiLevel = baselevel;
680 pItems[index].a.fLayoutRTL = odd(baselevel);
681 pItems[index].a.fRTL = odd(baselevel);
684 TRACE("index=%d cnt=%d iCharPos=%d\n", index, cnt, pItems[index].iCharPos);
688 /* While not strictly necessary according to the spec, make sure the n+1
689 * item is set up to prevent random behaviour if the caller erroneously
690 * checks the n+1 structure */
691 index++;
692 memset(&pItems[index].a, 0, sizeof(SCRIPT_ANALYSIS));
694 TRACE("index=%d cnt=%d iCharPos=%d\n", index, cnt, pItems[index].iCharPos);
696 /* Set one SCRIPT_STATE item being returned */
697 if (index + 1 > cMaxItems) return E_OUTOFMEMORY;
698 if (pcItems) *pcItems = index;
700 /* Set SCRIPT_ITEM */
701 pItems[index].iCharPos = cnt; /* the last item contains the ptr to the lastchar */
702 heap_free(levels);
703 return S_OK;
706 /***********************************************************************
707 * ScriptStringAnalyse (USP10.@)
710 HRESULT WINAPI ScriptStringAnalyse(HDC hdc, const void *pString, int cString,
711 int cGlyphs, int iCharset, DWORD dwFlags,
712 int iReqWidth, SCRIPT_CONTROL *psControl,
713 SCRIPT_STATE *psState, const int *piDx,
714 SCRIPT_TABDEF *pTabdef, const BYTE *pbInClass,
715 SCRIPT_STRING_ANALYSIS *pssa)
717 HRESULT hr = E_OUTOFMEMORY;
718 StringAnalysis *analysis = NULL;
719 int i, num_items = 255;
721 TRACE("(%p,%p,%d,%d,%d,0x%x,%d,%p,%p,%p,%p,%p,%p)\n",
722 hdc, pString, cString, cGlyphs, iCharset, dwFlags, iReqWidth,
723 psControl, psState, piDx, pTabdef, pbInClass, pssa);
725 if (iCharset != -1)
727 FIXME("Only Unicode strings are supported\n");
728 return E_INVALIDARG;
730 if (cString < 1 || !pString) return E_INVALIDARG;
731 if ((dwFlags & SSA_GLYPHS) && !hdc) return E_PENDING;
733 if (!(analysis = heap_alloc_zero(sizeof(StringAnalysis)))) return E_OUTOFMEMORY;
734 if (!(analysis->pItem = heap_alloc_zero(num_items * sizeof(SCRIPT_ITEM) + 1))) goto error;
736 /* FIXME: handle clipping */
737 analysis->clip_len = cString;
738 analysis->hdc = hdc;
740 hr = ScriptItemize(pString, cString, num_items, psControl, psState, analysis->pItem,
741 &analysis->numItems);
743 while (hr == E_OUTOFMEMORY)
745 SCRIPT_ITEM *tmp;
747 num_items *= 2;
748 if (!(tmp = heap_realloc_zero(analysis->pItem, num_items * sizeof(SCRIPT_ITEM) + 1)))
749 goto error;
751 analysis->pItem = tmp;
752 hr = ScriptItemize(pString, cString, num_items, psControl, psState, analysis->pItem,
753 &analysis->numItems);
755 if (hr != S_OK) goto error;
757 if ((analysis->logattrs = heap_alloc(sizeof(SCRIPT_LOGATTR) * cString)))
758 ScriptBreak(pString, cString, (SCRIPT_STRING_ANALYSIS)analysis, analysis->logattrs);
759 else
760 goto error;
762 if (!(analysis->glyphs = heap_alloc_zero(sizeof(StringGlyphs) * analysis->numItems)))
763 goto error;
765 for (i = 0; i < analysis->numItems; i++)
767 SCRIPT_CACHE *sc = (SCRIPT_CACHE *)&analysis->sc;
768 int cChar = analysis->pItem[i+1].iCharPos - analysis->pItem[i].iCharPos;
769 int numGlyphs = 1.5 * cChar + 16;
770 WORD *glyphs = heap_alloc_zero(sizeof(WORD) * numGlyphs);
771 WORD *pwLogClust = heap_alloc_zero(sizeof(WORD) * cChar);
772 int *piAdvance = heap_alloc_zero(sizeof(int) * numGlyphs);
773 SCRIPT_VISATTR *psva = heap_alloc_zero(sizeof(SCRIPT_VISATTR) * cChar);
774 GOFFSET *pGoffset = heap_alloc_zero(sizeof(GOFFSET) * numGlyphs);
775 ABC *abc = heap_alloc_zero(sizeof(ABC));
776 int numGlyphsReturned;
778 /* FIXME: non unicode strings */
779 const WCHAR* pStr = (const WCHAR*)pString;
780 hr = ScriptShape(hdc, sc, &pStr[analysis->pItem[i].iCharPos],
781 cChar, numGlyphs, &analysis->pItem[i].a,
782 glyphs, pwLogClust, psva, &numGlyphsReturned);
783 hr = ScriptPlace(hdc, sc, glyphs, numGlyphsReturned, psva, &analysis->pItem[i].a,
784 piAdvance, pGoffset, abc);
786 analysis->glyphs[i].numGlyphs = numGlyphsReturned;
787 analysis->glyphs[i].glyphs = glyphs;
788 analysis->glyphs[i].pwLogClust = pwLogClust;
789 analysis->glyphs[i].piAdvance = piAdvance;
790 analysis->glyphs[i].psva = psva;
791 analysis->glyphs[i].pGoffset = pGoffset;
792 analysis->glyphs[i].abc = abc;
795 *pssa = analysis;
796 return S_OK;
798 error:
799 heap_free(analysis->glyphs);
800 heap_free(analysis->logattrs);
801 heap_free(analysis->pItem);
802 heap_free(analysis->sc);
803 heap_free(analysis);
804 return hr;
807 /***********************************************************************
808 * ScriptStringOut (USP10.@)
810 * This function takes the output of ScriptStringAnalyse and joins the segments
811 * of glyphs and passes the resulting string to ScriptTextOut. ScriptStringOut
812 * only processes glyphs.
814 * Parameters:
815 * ssa [I] buffer to hold the analysed string components
816 * iX [I] X axis displacement for output
817 * iY [I] Y axis displacement for output
818 * uOptions [I] flags controling output processing
819 * prc [I] rectangle coordinates
820 * iMinSel [I] starting pos for substringing output string
821 * iMaxSel [I] ending pos for substringing output string
822 * fDisabled [I] controls text highlighting
824 * RETURNS
825 * Success: S_OK
826 * Failure: is the value returned by ScriptTextOut
828 HRESULT WINAPI ScriptStringOut(SCRIPT_STRING_ANALYSIS ssa,
829 int iX,
830 int iY,
831 UINT uOptions,
832 const RECT *prc,
833 int iMinSel,
834 int iMaxSel,
835 BOOL fDisabled)
837 StringAnalysis *analysis;
838 WORD *glyphs;
839 int item, cnt, x;
840 HRESULT hr;
842 TRACE("(%p,%d,%d,0x%1x,%p,%d,%d,%d)\n",
843 ssa, iX, iY, uOptions, prc, iMinSel, iMaxSel, fDisabled);
845 if (!(analysis = ssa)) return E_INVALIDARG;
848 * Get storage for the output buffer for the consolidated strings
850 cnt = 0;
851 for (item = 0; item < analysis->numItems; item++)
853 cnt += analysis->glyphs[item].numGlyphs;
855 if (!(glyphs = heap_alloc(sizeof(WCHAR) * cnt))) return E_OUTOFMEMORY;
858 * ScriptStringOut only processes glyphs hence set ETO_GLYPH_INDEX
860 uOptions |= ETO_GLYPH_INDEX;
861 analysis->pItem[0].a.fNoGlyphIndex = FALSE; /* say that we have glyphs */
864 * Copy the string items into the output buffer
867 TRACE("numItems %d\n", analysis->numItems);
869 cnt = 0;
870 for (item = 0; item < analysis->numItems; item++)
872 memcpy(&glyphs[cnt], analysis->glyphs[item].glyphs,
873 sizeof(WCHAR) * analysis->glyphs[item].numGlyphs);
875 TRACE("Item %d, Glyphs %d ", item, analysis->glyphs[item].numGlyphs);
876 for (x = cnt; x < analysis->glyphs[item].numGlyphs + cnt; x ++)
877 TRACE("%04x", glyphs[x]);
878 TRACE("\n");
880 cnt += analysis->glyphs[item].numGlyphs; /* point to the end of the copied text */
883 hr = ScriptTextOut(analysis->hdc, (SCRIPT_CACHE *)&analysis->sc, iX, iY,
884 uOptions, prc, &analysis->pItem->a, NULL, 0, glyphs, cnt,
885 analysis->glyphs->piAdvance, NULL, analysis->glyphs->pGoffset);
886 TRACE("ScriptTextOut hr=%08x\n", hr);
889 * Free the output buffer and script cache
891 heap_free(glyphs);
892 return hr;
895 /***********************************************************************
896 * ScriptStringCPtoX (USP10.@)
899 HRESULT WINAPI ScriptStringCPtoX(SCRIPT_STRING_ANALYSIS ssa, int icp, BOOL fTrailing, int* pX)
901 int i, j;
902 int runningX = 0;
903 int runningCp = 0;
904 StringAnalysis* analysis = ssa;
906 TRACE("(%p), %d, %d, (%p)\n", ssa, icp, fTrailing, pX);
908 if (!ssa || !pX) return S_FALSE;
910 /* icp out of range */
911 if(icp < 0)
913 analysis->invalid = TRUE;
914 return E_INVALIDARG;
917 for(i=0; i<analysis->numItems; i++)
919 for(j=0; j<analysis->glyphs[i].numGlyphs; j++)
921 if(runningCp == icp && fTrailing == FALSE)
923 *pX = runningX;
924 return S_OK;
926 runningX += analysis->glyphs[i].piAdvance[j];
927 if(runningCp == icp && fTrailing == TRUE)
929 *pX = runningX;
930 return S_OK;
932 runningCp++;
936 /* icp out of range */
937 analysis->invalid = TRUE;
938 return E_INVALIDARG;
941 /***********************************************************************
942 * ScriptStringXtoCP (USP10.@)
945 HRESULT WINAPI ScriptStringXtoCP(SCRIPT_STRING_ANALYSIS ssa, int iX, int* piCh, int* piTrailing)
947 StringAnalysis* analysis = ssa;
948 int i;
949 int j;
950 int runningX = 0;
951 int runningCp = 0;
952 int width;
954 TRACE("(%p), %d, (%p), (%p)\n", ssa, iX, piCh, piTrailing);
956 if (!ssa || !piCh || !piTrailing) return S_FALSE;
958 /* out of range */
959 if(iX < 0)
961 *piCh = -1;
962 *piTrailing = TRUE;
963 return S_OK;
966 for(i=0; i<analysis->numItems; i++)
968 for(j=0; j<analysis->glyphs[i].numGlyphs; j++)
970 width = analysis->glyphs[i].piAdvance[j];
971 if(iX < (runningX + width))
973 *piCh = runningCp;
974 if((iX - runningX) > width/2)
975 *piTrailing = TRUE;
976 else
977 *piTrailing = FALSE;
978 return S_OK;
980 runningX += width;
981 runningCp++;
985 /* out of range */
986 *piCh = analysis->pItem[analysis->numItems].iCharPos;
987 *piTrailing = FALSE;
989 return S_OK;
993 /***********************************************************************
994 * ScriptStringFree (USP10.@)
996 * Free a string analysis.
998 * PARAMS
999 * pssa [I] string analysis.
1001 * RETURNS
1002 * Success: S_OK
1003 * Failure: Non-zero HRESULT value.
1005 HRESULT WINAPI ScriptStringFree(SCRIPT_STRING_ANALYSIS *pssa)
1007 StringAnalysis* analysis;
1008 BOOL invalid;
1009 int i;
1011 TRACE("(%p)\n", pssa);
1013 if (!pssa || !(analysis = *pssa)) return E_INVALIDARG;
1015 invalid = analysis->invalid;
1016 ScriptFreeCache((SCRIPT_CACHE *)&analysis->sc);
1018 for (i = 0; i < analysis->numItems; i++)
1020 heap_free(analysis->glyphs[i].glyphs);
1021 heap_free(analysis->glyphs[i].pwLogClust);
1022 heap_free(analysis->glyphs[i].piAdvance);
1023 heap_free(analysis->glyphs[i].psva);
1024 heap_free(analysis->glyphs[i].pGoffset);
1025 heap_free(analysis->glyphs[i].abc);
1028 heap_free(analysis->glyphs);
1029 heap_free(analysis->pItem);
1030 heap_free(analysis->logattrs);
1031 heap_free(analysis->sz);
1032 heap_free(analysis->sc);
1033 heap_free(analysis);
1035 if (invalid) return E_INVALIDARG;
1036 return S_OK;
1039 /***********************************************************************
1040 * ScriptCPtoX (USP10.@)
1043 HRESULT WINAPI ScriptCPtoX(int iCP,
1044 BOOL fTrailing,
1045 int cChars,
1046 int cGlyphs,
1047 const WORD *pwLogClust,
1048 const SCRIPT_VISATTR *psva,
1049 const int *piAdvance,
1050 const SCRIPT_ANALYSIS *psa,
1051 int *piX)
1053 int item;
1054 int iPosX;
1055 float fMaxPosX = 0;
1056 TRACE("(%d,%d,%d,%d,%p,%p,%p,%p,%p)\n",
1057 iCP, fTrailing, cChars, cGlyphs, pwLogClust, psva, piAdvance,
1058 psa, piX);
1059 for (item=0; item < cGlyphs; item++) /* total piAdvance */
1060 fMaxPosX += piAdvance[item];
1061 iPosX = (fMaxPosX/cGlyphs)*(iCP+fTrailing);
1062 if (iPosX > fMaxPosX)
1063 iPosX = fMaxPosX;
1064 *piX = iPosX; /* Return something in range */
1066 TRACE("*piX=%d\n", *piX);
1067 return S_OK;
1070 /***********************************************************************
1071 * ScriptXtoCP (USP10.@)
1074 HRESULT WINAPI ScriptXtoCP(int iX,
1075 int cChars,
1076 int cGlyphs,
1077 const WORD *pwLogClust,
1078 const SCRIPT_VISATTR *psva,
1079 const int *piAdvance,
1080 const SCRIPT_ANALYSIS *psa,
1081 int *piCP,
1082 int *piTrailing)
1084 int item;
1085 int iPosX;
1086 float fMaxPosX = 1;
1087 float fAvePosX;
1088 TRACE("(%d,%d,%d,%p,%p,%p,%p,%p,%p)\n",
1089 iX, cChars, cGlyphs, pwLogClust, psva, piAdvance,
1090 psa, piCP, piTrailing);
1091 if (iX < 0) /* iX is before start of run */
1093 *piCP = -1;
1094 *piTrailing = TRUE;
1095 return S_OK;
1098 for (item=0; item < cGlyphs; item++) /* total piAdvance */
1099 fMaxPosX += piAdvance[item];
1101 if (iX >= fMaxPosX) /* iX too large */
1103 *piCP = cChars;
1104 *piTrailing = FALSE;
1105 return S_OK;
1108 fAvePosX = fMaxPosX / cGlyphs;
1109 iPosX = fAvePosX;
1110 for (item = 1; item < cGlyphs && iPosX < iX; item++)
1111 iPosX += fAvePosX;
1112 if (iPosX - iX > fAvePosX/2)
1113 *piTrailing = 0;
1114 else
1115 *piTrailing = 1; /* yep we are over halfway */
1117 *piCP = item -1; /* Return character position */
1118 TRACE("*piCP=%d iPposX=%d\n", *piCP, iPosX);
1119 return S_OK;
1122 /***********************************************************************
1123 * ScriptBreak (USP10.@)
1125 * Retrieve line break information.
1127 * PARAMS
1128 * chars [I] Array of characters.
1129 * sa [I] String analysis.
1130 * la [I] Array of logical attribute structures.
1132 * RETURNS
1133 * Success: S_OK
1134 * Failure: S_FALSE
1136 HRESULT WINAPI ScriptBreak(const WCHAR *chars, int count, const SCRIPT_ANALYSIS *sa, SCRIPT_LOGATTR *la)
1138 int i;
1140 TRACE("(%s, %d, %p, %p)\n", debugstr_wn(chars, count), count, sa, la);
1142 if (!la) return S_FALSE;
1144 for (i = 0; i < count; i++)
1146 memset(&la[i], 0, sizeof(SCRIPT_LOGATTR));
1148 /* FIXME: set the other flags */
1149 la[i].fWhiteSpace = (chars[i] == ' ');
1150 la[i].fCharStop = 1;
1152 if (i > 0 && la[i - 1].fWhiteSpace)
1154 la[i].fSoftBreak = 1;
1155 la[i].fWordStop = 1;
1158 return S_OK;
1161 /***********************************************************************
1162 * ScriptIsComplex (USP10.@)
1164 * Determine if a string is complex.
1166 * PARAMS
1167 * chars [I] Array of characters to test.
1168 * len [I] Length in characters.
1169 * flag [I] Flag.
1171 * RETURNS
1172 * Success: S_OK
1173 * Failure: S_FALSE
1176 HRESULT WINAPI ScriptIsComplex(const WCHAR *chars, int len, DWORD flag)
1178 int i;
1180 TRACE("(%s,%d,0x%x)\n", debugstr_wn(chars, len), len, flag);
1182 for (i = 0; i < len; i++)
1184 int script;
1186 if ((flag & SIC_ASCIIDIGIT) && chars[i] >= 0x30 && chars[i] <= 0x39)
1187 return S_OK;
1189 script = get_char_script(chars[i]);
1190 if ((scriptInformation[script].props.fComplex && (flag & SIC_COMPLEX))||
1191 (!scriptInformation[script].props.fComplex && (flag & SIC_NEUTRAL)))
1192 return S_OK;
1194 return S_FALSE;
1197 /***********************************************************************
1198 * ScriptShape (USP10.@)
1200 * Produce glyphs and visual attributes for a run.
1202 * PARAMS
1203 * hdc [I] Device context.
1204 * psc [I/O] Opaque pointer to a script cache.
1205 * pwcChars [I] Array of characters specifying the run.
1206 * cChars [I] Number of characters in pwcChars.
1207 * cMaxGlyphs [I] Length of pwOutGlyphs.
1208 * psa [I/O] Script analysis.
1209 * pwOutGlyphs [O] Array of glyphs.
1210 * pwLogClust [O] Array of logical cluster info.
1211 * psva [O] Array of visual attributes.
1212 * pcGlyphs [O] Number of glyphs returned.
1214 * RETURNS
1215 * Success: S_OK
1216 * Failure: Non-zero HRESULT value.
1218 HRESULT WINAPI ScriptShape(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcChars,
1219 int cChars, int cMaxGlyphs,
1220 SCRIPT_ANALYSIS *psa, WORD *pwOutGlyphs, WORD *pwLogClust,
1221 SCRIPT_VISATTR *psva, int *pcGlyphs)
1223 HRESULT hr;
1224 unsigned int i;
1225 BOOL rtl;
1227 TRACE("(%p, %p, %s, %d, %d, %p, %p, %p, %p, %p)\n", hdc, psc, debugstr_wn(pwcChars, cChars),
1228 cChars, cMaxGlyphs, psa, pwOutGlyphs, pwLogClust, psva, pcGlyphs);
1230 if (psa) TRACE("psa values: %d, %d, %d, %d, %d, %d, %d\n", psa->eScript, psa->fRTL, psa->fLayoutRTL,
1231 psa->fLinkBefore, psa->fLinkAfter, psa->fLogicalOrder, psa->fNoGlyphIndex);
1233 if (!psva || !pcGlyphs) return E_INVALIDARG;
1234 if (cChars > cMaxGlyphs) return E_OUTOFMEMORY;
1235 rtl = (!psa->fLogicalOrder && psa->fRTL);
1237 *pcGlyphs = cChars;
1238 if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1239 if (!pwLogClust) return E_FAIL;
1241 /* Initialize a SCRIPT_VISATTR and LogClust for each char in this run */
1242 for (i = 0; i < cChars; i++)
1244 int idx = i;
1245 if (rtl) idx = cChars - 1 - i;
1246 /* FIXME: set to better values */
1247 psva[i].uJustification = (pwcChars[idx] == ' ') ? SCRIPT_JUSTIFY_BLANK : SCRIPT_JUSTIFY_CHARACTER;
1248 psva[i].fClusterStart = 1;
1249 psva[i].fDiacritic = 0;
1250 psva[i].fZeroWidth = 0;
1251 psva[i].fReserved = 0;
1252 psva[i].fShapeReserved = 0;
1254 pwLogClust[i] = idx;
1257 if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE) && !psa->fNoGlyphIndex)
1259 WCHAR *rChars = heap_alloc(sizeof(WCHAR) * cChars);
1260 if (!rChars) return E_OUTOFMEMORY;
1261 for (i = 0; i < cChars; i++)
1263 int idx = i;
1264 WCHAR chInput;
1265 if (rtl) idx = cChars - 1 - i;
1266 if (psa->fRTL)
1267 chInput = mirror_char(pwcChars[idx]);
1268 else
1269 chInput = pwcChars[idx];
1270 if (!(pwOutGlyphs[i] = get_cache_glyph(psc, chInput)))
1272 WORD glyph;
1273 if (!hdc) return E_PENDING;
1274 if (GetGlyphIndicesW(hdc, &chInput, 1, &glyph, 0) == GDI_ERROR) return S_FALSE;
1275 pwOutGlyphs[i] = set_cache_glyph(psc, chInput, glyph);
1277 rChars[i] = chInput;
1279 SHAPE_ContextualShaping(hdc, (ScriptCache *)*psc, psa, rChars, cChars, pwOutGlyphs, pcGlyphs, cMaxGlyphs, pwLogClust);
1280 SHAPE_ApplyDefaultOpentypeFeatures(hdc, (ScriptCache *)*psc, psa, pwOutGlyphs, pcGlyphs, cMaxGlyphs, cChars, pwLogClust);
1281 heap_free(rChars);
1283 else
1285 TRACE("no glyph translation\n");
1286 for (i = 0; i < cChars; i++)
1288 int idx = i;
1289 /* No mirroring done here */
1290 if (rtl) idx = cChars - 1 - i;
1291 pwOutGlyphs[i] = pwcChars[idx];
1295 return S_OK;
1298 /***********************************************************************
1299 * ScriptPlace (USP10.@)
1301 * Produce advance widths for a run.
1303 * PARAMS
1304 * hdc [I] Device context.
1305 * psc [I/O] Opaque pointer to a script cache.
1306 * pwGlyphs [I] Array of glyphs.
1307 * cGlyphs [I] Number of glyphs in pwGlyphs.
1308 * psva [I] Array of visual attributes.
1309 * psa [I/O] String analysis.
1310 * piAdvance [O] Array of advance widths.
1311 * pGoffset [O] Glyph offsets.
1312 * pABC [O] Combined ABC width.
1314 * RETURNS
1315 * Success: S_OK
1316 * Failure: Non-zero HRESULT value.
1318 HRESULT WINAPI ScriptPlace(HDC hdc, SCRIPT_CACHE *psc, const WORD *pwGlyphs,
1319 int cGlyphs, const SCRIPT_VISATTR *psva,
1320 SCRIPT_ANALYSIS *psa, int *piAdvance, GOFFSET *pGoffset, ABC *pABC )
1322 HRESULT hr;
1323 int i;
1325 TRACE("(%p, %p, %p, %d, %p, %p, %p, %p, %p)\n", hdc, psc, pwGlyphs, cGlyphs, psva, psa,
1326 piAdvance, pGoffset, pABC);
1328 if (!psva) return E_INVALIDARG;
1329 if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1330 if (!pGoffset) return E_FAIL;
1332 if (pABC) memset(pABC, 0, sizeof(ABC));
1333 for (i = 0; i < cGlyphs; i++)
1335 ABC abc;
1336 if (!get_cache_glyph_widths(psc, pwGlyphs[i], &abc))
1338 if (!hdc) return E_PENDING;
1339 if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE) && !psa->fNoGlyphIndex)
1341 if (!GetCharABCWidthsI(hdc, 0, 1, (WORD *)&pwGlyphs[i], &abc)) return S_FALSE;
1343 else
1345 INT width;
1346 if (!GetCharWidth32W(hdc, pwGlyphs[i], pwGlyphs[i], &width)) return S_FALSE;
1347 abc.abcB = width;
1348 abc.abcA = abc.abcC = 0;
1350 set_cache_glyph_widths(psc, pwGlyphs[i], &abc);
1352 if (pABC)
1354 pABC->abcA += abc.abcA;
1355 pABC->abcB += abc.abcB;
1356 pABC->abcC += abc.abcC;
1358 /* FIXME: set to more reasonable values */
1359 pGoffset[i].du = pGoffset[i].dv = 0;
1360 if (piAdvance) piAdvance[i] = abc.abcA + abc.abcB + abc.abcC;
1363 if (pABC) TRACE("Total for run: abcA=%d, abcB=%d, abcC=%d\n", pABC->abcA, pABC->abcB, pABC->abcC);
1364 return S_OK;
1367 /***********************************************************************
1368 * ScriptGetCMap (USP10.@)
1370 * Retrieve glyph indices.
1372 * PARAMS
1373 * hdc [I] Device context.
1374 * psc [I/O] Opaque pointer to a script cache.
1375 * pwcInChars [I] Array of Unicode characters.
1376 * cChars [I] Number of characters in pwcInChars.
1377 * dwFlags [I] Flags.
1378 * pwOutGlyphs [O] Buffer to receive the array of glyph indices.
1380 * RETURNS
1381 * Success: S_OK
1382 * Failure: Non-zero HRESULT value.
1384 HRESULT WINAPI ScriptGetCMap(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcInChars,
1385 int cChars, DWORD dwFlags, WORD *pwOutGlyphs)
1387 HRESULT hr;
1388 int i;
1390 TRACE("(%p,%p,%s,%d,0x%x,%p)\n", hdc, psc, debugstr_wn(pwcInChars, cChars),
1391 cChars, dwFlags, pwOutGlyphs);
1393 if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1395 hr = S_OK;
1397 if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE))
1399 for (i = 0; i < cChars; i++)
1401 WCHAR inChar;
1402 if (dwFlags == SGCM_RTL)
1403 inChar = mirror_char(pwcInChars[i]);
1404 else
1405 inChar = pwcInChars[i];
1406 if (!(pwOutGlyphs[i] = get_cache_glyph(psc, inChar)))
1408 WORD glyph;
1409 if (!hdc) return E_PENDING;
1410 if (GetGlyphIndicesW(hdc, &inChar, 1, &glyph, GGI_MARK_NONEXISTING_GLYPHS) == GDI_ERROR) return S_FALSE;
1411 if (glyph == 0xffff)
1413 hr = S_FALSE;
1414 glyph = 0x0;
1416 pwOutGlyphs[i] = set_cache_glyph(psc, inChar, glyph);
1420 else
1422 TRACE("no glyph translation\n");
1423 for (i = 0; i < cChars; i++)
1425 WCHAR inChar;
1426 if (dwFlags == SGCM_RTL)
1427 inChar = mirror_char(pwcInChars[i]);
1428 else
1429 inChar = pwcInChars[i];
1430 pwOutGlyphs[i] = inChar;
1433 return hr;
1436 /***********************************************************************
1437 * ScriptTextOut (USP10.@)
1440 HRESULT WINAPI ScriptTextOut(const HDC hdc, SCRIPT_CACHE *psc, int x, int y, UINT fuOptions,
1441 const RECT *lprc, const SCRIPT_ANALYSIS *psa, const WCHAR *pwcReserved,
1442 int iReserved, const WORD *pwGlyphs, int cGlyphs, const int *piAdvance,
1443 const int *piJustify, const GOFFSET *pGoffset)
1445 HRESULT hr = S_OK;
1447 TRACE("(%p, %p, %d, %d, %04x, %p, %p, %p, %d, %p, %d, %p, %p, %p)\n",
1448 hdc, psc, x, y, fuOptions, lprc, psa, pwcReserved, iReserved, pwGlyphs, cGlyphs,
1449 piAdvance, piJustify, pGoffset);
1451 if (!hdc || !psc) return E_INVALIDARG;
1452 if (!piAdvance || !psa || !pwGlyphs) return E_INVALIDARG;
1454 fuOptions &= ETO_CLIPPED + ETO_OPAQUE;
1455 fuOptions |= ETO_IGNORELANGUAGE;
1456 if (!psa->fNoGlyphIndex) /* Have Glyphs? */
1457 fuOptions |= ETO_GLYPH_INDEX; /* Say don't do translation to glyph */
1459 if (psa->fRTL && psa->fLogicalOrder)
1461 int i;
1462 WORD *rtlGlyphs;
1464 rtlGlyphs = heap_alloc(cGlyphs * sizeof(WORD));
1465 if (!rtlGlyphs)
1466 return E_OUTOFMEMORY;
1468 for (i = 0; i < cGlyphs; i++)
1469 rtlGlyphs[i] = pwGlyphs[cGlyphs-1-i];
1471 if (!ExtTextOutW(hdc, x, y, fuOptions, lprc, rtlGlyphs, cGlyphs, NULL))
1472 hr = S_FALSE;
1473 heap_free(rtlGlyphs);
1475 else
1476 if (!ExtTextOutW(hdc, x, y, fuOptions, lprc, pwGlyphs, cGlyphs, NULL))
1477 hr = S_FALSE;
1479 return hr;
1482 /***********************************************************************
1483 * ScriptCacheGetHeight (USP10.@)
1485 * Retrieve the height of the font in the cache.
1487 * PARAMS
1488 * hdc [I] Device context.
1489 * psc [I/O] Opaque pointer to a script cache.
1490 * height [O] Receives font height.
1492 * RETURNS
1493 * Success: S_OK
1494 * Failure: Non-zero HRESULT value.
1496 HRESULT WINAPI ScriptCacheGetHeight(HDC hdc, SCRIPT_CACHE *psc, LONG *height)
1498 HRESULT hr;
1500 TRACE("(%p, %p, %p)\n", hdc, psc, height);
1502 if (!height) return E_INVALIDARG;
1503 if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1505 *height = get_cache_height(psc);
1506 return S_OK;
1509 /***********************************************************************
1510 * ScriptGetGlyphABCWidth (USP10.@)
1512 * Retrieve the width of a glyph.
1514 * PARAMS
1515 * hdc [I] Device context.
1516 * psc [I/O] Opaque pointer to a script cache.
1517 * glyph [I] Glyph to retrieve the width for.
1518 * abc [O] ABC widths of the glyph.
1520 * RETURNS
1521 * Success: S_OK
1522 * Failure: Non-zero HRESULT value.
1524 HRESULT WINAPI ScriptGetGlyphABCWidth(HDC hdc, SCRIPT_CACHE *psc, WORD glyph, ABC *abc)
1526 HRESULT hr;
1528 TRACE("(%p, %p, 0x%04x, %p)\n", hdc, psc, glyph, abc);
1530 if (!abc) return E_INVALIDARG;
1531 if ((hr = init_script_cache(hdc, psc)) != S_OK) return hr;
1533 if (!get_cache_glyph_widths(psc, glyph, abc))
1535 if (!hdc) return E_PENDING;
1536 if ((get_cache_pitch_family(psc) & TMPF_TRUETYPE))
1538 if (!GetCharABCWidthsI(hdc, 0, 1, &glyph, abc)) return S_FALSE;
1540 else
1542 INT width;
1543 if (!GetCharWidth32W(hdc, glyph, glyph, &width)) return S_FALSE;
1544 abc->abcB = width;
1545 abc->abcA = abc->abcC = 0;
1547 set_cache_glyph_widths(psc, glyph, abc);
1549 return S_OK;
1552 /***********************************************************************
1553 * ScriptLayout (USP10.@)
1555 * Map embedding levels to visual and/or logical order.
1557 * PARAMS
1558 * runs [I] Size of level array.
1559 * level [I] Array of embedding levels.
1560 * vistolog [O] Map of embedding levels from visual to logical order.
1561 * logtovis [O] Map of embedding levels from logical to visual order.
1563 * RETURNS
1564 * Success: S_OK
1565 * Failure: Non-zero HRESULT value.
1567 * BUGS
1568 * This stub works correctly for any sequence of a single
1569 * embedding level but not for sequences of different
1570 * embedding levels, i.e. mixtures of RTL and LTR scripts.
1572 HRESULT WINAPI ScriptLayout(int runs, const BYTE *level, int *vistolog, int *logtovis)
1574 int* indexs;
1575 int ich;
1577 TRACE("(%d, %p, %p, %p)\n", runs, level, vistolog, logtovis);
1579 if (!level || (!vistolog && !logtovis))
1580 return E_INVALIDARG;
1582 indexs = heap_alloc(sizeof(int) * runs);
1583 if (!indexs)
1584 return E_OUTOFMEMORY;
1587 if (vistolog)
1589 for( ich = 0; ich < runs; ich++)
1590 indexs[ich] = ich;
1592 ich = 0;
1593 while (ich < runs)
1594 ich += BIDI_ReorderV2lLevel(0, indexs+ich, level+ich, runs - ich, FALSE);
1595 for (ich = 0; ich < runs; ich++)
1596 vistolog[ich] = indexs[ich];
1600 if (logtovis)
1602 for( ich = 0; ich < runs; ich++)
1603 indexs[ich] = ich;
1605 ich = 0;
1606 while (ich < runs)
1607 ich += BIDI_ReorderL2vLevel(0, indexs+ich, level+ich, runs - ich, FALSE);
1608 for (ich = 0; ich < runs; ich++)
1609 logtovis[ich] = indexs[ich];
1611 heap_free(indexs);
1613 return S_OK;
1616 /***********************************************************************
1617 * ScriptStringGetLogicalWidths (USP10.@)
1619 * Returns logical widths from a string analysis.
1621 * PARAMS
1622 * ssa [I] string analysis.
1623 * piDx [O] logical widths returned.
1625 * RETURNS
1626 * Success: S_OK
1627 * Failure: a non-zero HRESULT.
1629 HRESULT WINAPI ScriptStringGetLogicalWidths(SCRIPT_STRING_ANALYSIS ssa, int *piDx)
1631 int i, j, next = 0;
1632 StringAnalysis *analysis = ssa;
1634 TRACE("%p, %p\n", ssa, piDx);
1636 if (!analysis) return S_FALSE;
1638 for (i = 0; i < analysis->numItems; i++)
1640 for (j = 0; j < analysis->glyphs[i].numGlyphs; j++)
1642 piDx[next] = analysis->glyphs[i].piAdvance[j];
1643 next++;
1646 return S_OK;
1649 /***********************************************************************
1650 * ScriptStringValidate (USP10.@)
1652 * Validate a string analysis.
1654 * PARAMS
1655 * ssa [I] string analysis.
1657 * RETURNS
1658 * Success: S_OK
1659 * Failure: S_FALSE if invalid sequences are found
1660 * or a non-zero HRESULT if it fails.
1662 HRESULT WINAPI ScriptStringValidate(SCRIPT_STRING_ANALYSIS ssa)
1664 StringAnalysis *analysis = ssa;
1666 TRACE("(%p)\n", ssa);
1668 if (!analysis) return E_INVALIDARG;
1669 return (analysis->invalid) ? S_FALSE : S_OK;
1672 /***********************************************************************
1673 * ScriptString_pSize (USP10.@)
1675 * Retrieve width and height of an analysed string.
1677 * PARAMS
1678 * ssa [I] string analysis.
1680 * RETURNS
1681 * Success: Pointer to a SIZE structure.
1682 * Failure: NULL
1684 const SIZE * WINAPI ScriptString_pSize(SCRIPT_STRING_ANALYSIS ssa)
1686 int i, j;
1687 StringAnalysis *analysis = ssa;
1689 TRACE("(%p)\n", ssa);
1691 if (!analysis) return NULL;
1693 if (!analysis->sz)
1695 if (!(analysis->sz = heap_alloc(sizeof(SIZE)))) return NULL;
1696 analysis->sz->cy = analysis->sc->tm.tmHeight;
1698 analysis->sz->cx = 0;
1699 for (i = 0; i < analysis->numItems; i++)
1700 for (j = 0; j < analysis->glyphs[i].numGlyphs; j++)
1701 analysis->sz->cx += analysis->glyphs[i].piAdvance[j];
1703 return analysis->sz;
1706 /***********************************************************************
1707 * ScriptString_pLogAttr (USP10.@)
1709 * Retrieve logical attributes of an analysed string.
1711 * PARAMS
1712 * ssa [I] string analysis.
1714 * RETURNS
1715 * Success: Pointer to an array of SCRIPT_LOGATTR structures.
1716 * Failure: NULL
1718 const SCRIPT_LOGATTR * WINAPI ScriptString_pLogAttr(SCRIPT_STRING_ANALYSIS ssa)
1720 StringAnalysis *analysis = ssa;
1722 TRACE("(%p)\n", ssa);
1724 if (!analysis) return NULL;
1725 return analysis->logattrs;
1728 /***********************************************************************
1729 * ScriptString_pcOutChars (USP10.@)
1731 * Retrieve the length of a string after clipping.
1733 * PARAMS
1734 * ssa [I] String analysis.
1736 * RETURNS
1737 * Success: Pointer to the length.
1738 * Failure: NULL
1740 const int * WINAPI ScriptString_pcOutChars(SCRIPT_STRING_ANALYSIS ssa)
1742 StringAnalysis *analysis = ssa;
1744 TRACE("(%p)\n", ssa);
1746 if (!analysis) return NULL;
1747 return &analysis->clip_len;
1750 /***********************************************************************
1751 * ScriptStringGetOrder (USP10.@)
1753 * Retrieve a glyph order map.
1755 * PARAMS
1756 * ssa [I] String analysis.
1757 * order [I/O] Array of glyph positions.
1759 * RETURNS
1760 * Success: S_OK
1761 * Failure: a non-zero HRESULT.
1763 HRESULT WINAPI ScriptStringGetOrder(SCRIPT_STRING_ANALYSIS ssa, UINT *order)
1765 int i, j;
1766 unsigned int k;
1767 StringAnalysis *analysis = ssa;
1769 TRACE("(%p)\n", ssa);
1771 if (!analysis) return S_FALSE;
1773 /* FIXME: handle RTL scripts */
1774 for (i = 0, k = 0; i < analysis->numItems; i++)
1775 for (j = 0; j < analysis->glyphs[i].numGlyphs; j++, k++)
1776 order[k] = k;
1778 return S_OK;
1781 /***********************************************************************
1782 * ScriptGetLogicalWidths (USP10.@)
1784 * Convert advance widths to logical widths.
1786 * PARAMS
1787 * sa [I] Script analysis.
1788 * nbchars [I] Number of characters.
1789 * nbglyphs [I] Number of glyphs.
1790 * glyph_width [I] Array of glyph widths.
1791 * log_clust [I] Array of logical clusters.
1792 * sva [I] Visual attributes.
1793 * widths [O] Array of logical widths.
1795 * RETURNS
1796 * Success: S_OK
1797 * Failure: a non-zero HRESULT.
1799 HRESULT WINAPI ScriptGetLogicalWidths(const SCRIPT_ANALYSIS *sa, int nbchars, int nbglyphs,
1800 const int *glyph_width, const WORD *log_clust,
1801 const SCRIPT_VISATTR *sva, int *widths)
1803 int i;
1805 TRACE("(%p, %d, %d, %p, %p, %p, %p)\n",
1806 sa, nbchars, nbglyphs, glyph_width, log_clust, sva, widths);
1808 /* FIXME */
1809 for (i = 0; i < nbchars; i++) widths[i] = glyph_width[i];
1810 return S_OK;
1813 /***********************************************************************
1814 * ScriptApplyLogicalWidth (USP10.@)
1816 * Generate glyph advance widths.
1818 * PARAMS
1819 * dx [I] Array of logical advance widths.
1820 * num_chars [I] Number of characters.
1821 * num_glyphs [I] Number of glyphs.
1822 * log_clust [I] Array of logical clusters.
1823 * sva [I] Visual attributes.
1824 * advance [I] Array of glyph advance widths.
1825 * sa [I] Script analysis.
1826 * abc [I/O] Summed ABC widths.
1827 * justify [O] Array of glyph advance widths.
1829 * RETURNS
1830 * Success: S_OK
1831 * Failure: a non-zero HRESULT.
1833 HRESULT WINAPI ScriptApplyLogicalWidth(const int *dx, int num_chars, int num_glyphs,
1834 const WORD *log_clust, const SCRIPT_VISATTR *sva,
1835 const int *advance, const SCRIPT_ANALYSIS *sa,
1836 ABC *abc, int *justify)
1838 int i;
1840 FIXME("(%p, %d, %d, %p, %p, %p, %p, %p, %p)\n",
1841 dx, num_chars, num_glyphs, log_clust, sva, advance, sa, abc, justify);
1843 for (i = 0; i < num_chars; i++) justify[i] = advance[i];
1844 return S_OK;
1847 HRESULT WINAPI ScriptJustify(const SCRIPT_VISATTR *sva, const int *advance,
1848 int num_glyphs, int dx, int min_kashida, int *justify)
1850 int i;
1852 FIXME("(%p, %p, %d, %d, %d, %p)\n", sva, advance, num_glyphs, dx, min_kashida, justify);
1854 for (i = 0; i < num_glyphs; i++) justify[i] = advance[i];
1855 return S_OK;