2 * Implementation of Uniscribe Script Processor (usp10.dll)
4 * Copyright 2005 Steven Edwards for CodeWeavers
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * Uniscribe allows for processing of complex scripts such as joining
22 * and filtering characters and bi-directional text with custom line breaks.
33 #include "wine/debug.h"
36 * some documentation here:
37 * http://www.microsoft.com/typography/developers/uniscribe/uniscribe.htm
40 WINE_DEFAULT_DEBUG_CHANNEL(uniscribe
);
44 /* Set up a default for ScriptGetProperties */
45 static const SCRIPT_PROPERTIES Default_Script_0
= {0, 0, 0, 0, 0, 0, 0, 0,
47 static const SCRIPT_PROPERTIES Default_Script_1
= {0, 0, 0, 0, 0, 0, 0, 0,
49 static const SCRIPT_PROPERTIES Default_Script_2
= {0, 0, 0, 0, 0, 0, 0, 0,
51 static const SCRIPT_PROPERTIES Default_Script_3
= {9, 0, 0, 0, 0, 0, 0, 0,
53 static const SCRIPT_PROPERTIES Default_Script_4
= {9, 1, 0, 0, 0, 0, 0, 0,
55 static const SCRIPT_PROPERTIES Default_Script_5
= {9, 0, 0, 0, 0, 0, 0, 0,
57 static const SCRIPT_PROPERTIES Default_Script_6
= {9, 1, 0, 0, 0, 0, 0, 0,
59 static const SCRIPT_PROPERTIES Default_Script_7
= {8, 0, 0, 0, 0, 161, 0, 0,
61 static const SCRIPT_PROPERTIES
*Global_Script
[MAX_SCRIPTS
] =
71 typedef struct scriptcache
{
73 DWORD GlyphToChar
[256];
78 BOOL WINAPI
DllMain(HINSTANCE hInstDLL
, DWORD fdwReason
, LPVOID lpv
)
81 case DLL_PROCESS_ATTACH
:
82 DisableThreadLibraryCalls(hInstDLL
);
84 case DLL_PROCESS_DETACH
:
90 /***********************************************************************
91 * ScriptFreeCache (USP10.@)
94 HRESULT WINAPI
ScriptFreeCache(SCRIPT_CACHE
*psc
)
99 HeapFree ( GetProcessHeap(), 0, *psc
);
105 /***********************************************************************
106 * ScriptGetProperties (USP10.@)
109 HRESULT WINAPI
ScriptGetProperties(const SCRIPT_PROPERTIES
***ppSp
, int *piNumScripts
)
111 TRACE("%p,%p\n",ppSp
, piNumScripts
);
113 /* Set up a sensible default and intialise pointers */
114 *piNumScripts
= MAX_SCRIPTS
;
115 *ppSp
= Global_Script
;
116 TRACE("ppSp:%p, *ppSp:%p, **ppSp:%p, %d\n", ppSp
, *ppSp
, **ppSp
,
121 /***********************************************************************
122 * ScriptGetFontProperties (USP10.@)
125 HRESULT WINAPI
ScriptGetFontProperties(HDC hdc
, SCRIPT_CACHE
*psc
, SCRIPT_FONTPROPERTIES
*sfp
)
127 FIXME("%p,%p,%p\n", hdc
, psc
, sfp
);
128 /* return something sensible? */
130 sfp
->cBytes
= sizeof(SCRIPT_FONTPROPERTIES
);
135 sfp
->iKashidaWidth
= 0;
140 /***********************************************************************
141 * ScriptRecordDigitSubstitution (USP10.@)
144 HRESULT WINAPI
ScriptRecordDigitSubstitution(LCID Locale
,SCRIPT_DIGITSUBSTITUTE
*psds
)
146 FIXME("%ld,%p\n",Locale
,psds
);
150 /***********************************************************************
151 * ScriptApplyDigitSubstitution (USP10.@)
154 HRESULT WINAPI
ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE
* psds
,
155 SCRIPT_CONTROL
* psc
, SCRIPT_STATE
* pss
)
157 FIXME("%p,%p,%p\n",psds
,psc
,pss
);
161 /***********************************************************************
162 * ScriptItemize (USP10.@)
165 HRESULT WINAPI
ScriptItemize(const WCHAR
*pwcInChars
, int cInChars
, int cMaxItems
,
166 const SCRIPT_CONTROL
*psControl
, const SCRIPT_STATE
*psState
,
167 SCRIPT_ITEM
*pItems
, int *pcItems
)
169 /* This implementation currently treats the entire string represented in
170 * pwcInChars as a single entity. Hence pcItems will be set to 1. */
172 FIXME("%s,%d,%d,%p,%p,%p,%p: semi-stub\n", debugstr_w(pwcInChars
), cInChars
, cMaxItems
,
173 psControl
, psState
, pItems
, pcItems
);
175 if (!pwcInChars
|| !cInChars
|| !pItems
|| cMaxItems
< 2)
178 /* Set a sensible default */
179 /* Set SCRIPT_ITEM */
180 pItems
[0].iCharPos
= 0;
181 /* Set the SCRIPT_ANALYSIS */
182 pItems
[0].a
.eScript
= SCRIPT_UNDEFINED
;
183 pItems
[0].a
.fRTL
= 0;
184 pItems
[0].a
.fLayoutRTL
= 0;
185 pItems
[0].a
.fLinkBefore
= 0;
186 pItems
[0].a
.fLinkAfter
= 0;
187 pItems
[0].a
.fLogicalOrder
= 0;
188 pItems
[0].a
.fNoGlyphIndex
= 0;
189 /* set the SCRIPT_STATE */
190 pItems
[0].a
.s
.uBidiLevel
= 0;
191 pItems
[0].a
.s
.fOverrideDirection
= 0;
192 pItems
[0].a
.s
.fInhibitSymSwap
= FALSE
;
193 pItems
[0].a
.s
.fCharShape
= 0;
194 pItems
[0].a
.s
.fDigitSubstitute
= 0;
195 pItems
[0].a
.s
.fInhibitLigate
= 0;
196 pItems
[0].a
.s
.fDisplayZWG
= 0;
197 pItems
[0].a
.s
.fArabicNumContext
= 0;
198 pItems
[0].a
.s
.fGcpClusters
= 0;
199 pItems
[0].a
.s
.fReserved
= 0;
200 pItems
[0].a
.s
.fEngineReserved
= 0;
202 /* While not strickly necessary according to the spec, make sure the n+1
203 * item is set up to prevent random behaviour if the caller eroneously
204 * checks the n+1 structure */
205 pItems
[1].a
.eScript
= 0;
206 pItems
[1].a
.fRTL
= 0;
207 pItems
[1].a
.fLayoutRTL
= 0;
208 pItems
[1].a
.fLinkBefore
= 0;
209 pItems
[1].a
.fLinkAfter
= 0;
210 pItems
[1].a
.fLogicalOrder
= 0;
211 pItems
[1].a
.fNoGlyphIndex
= 0;
212 /* set the SCRIPT_STATE */
213 pItems
[1].a
.s
.uBidiLevel
= 0;
214 pItems
[1].a
.s
.fOverrideDirection
= 0;
215 pItems
[1].a
.s
.fInhibitSymSwap
= FALSE
;
216 pItems
[1].a
.s
.fCharShape
= 0;
217 pItems
[1].a
.s
.fDigitSubstitute
= 0;
218 pItems
[1].a
.s
.fInhibitLigate
= 0;
219 pItems
[1].a
.s
.fDisplayZWG
= 0;
220 pItems
[1].a
.s
.fArabicNumContext
= 0;
221 pItems
[1].a
.s
.fGcpClusters
= 0;
222 pItems
[1].a
.s
.fReserved
= 0;
223 pItems
[1].a
.s
.fEngineReserved
= 0;
225 /* Set one SCRIPT_STATE item being returned */
228 /* Set SCRIPT_ITEM */
229 pItems
[1].iCharPos
= cInChars
- pItems
[0].iCharPos
; /* the last + 1 item
230 contains the ptr to the lastchar */
231 TRACE("%s,%d,%d,%p,%p,%p,%p,%d\n", debugstr_w(pwcInChars
), cInChars
, cMaxItems
,
232 psControl
, psState
, pItems
, pcItems
, *pcItems
);
233 TRACE("Start Pos in string: %d, Stop Pos %d\n", pItems
[0].iCharPos
, pItems
[1].iCharPos
);
237 /***********************************************************************
238 * ScriptStringAnalyse (USP10.@)
241 HRESULT WINAPI
ScriptStringAnalyse(HDC hdc
,
248 SCRIPT_CONTROL
*psControl
,
249 SCRIPT_STATE
*psState
,
251 SCRIPT_TABDEF
*pTabdef
,
252 const BYTE
*pbInClass
,
253 SCRIPT_STRING_ANALYSIS
*pssa
)
255 FIXME("(%p,%p,%d,%d,%d,0x%lx,%d,%p,%p,%p,%p,%p,%p): stub\n",
256 hdc
, pString
, cString
, cGlyphs
, iCharset
, dwFlags
,
257 iReqWidth
, psControl
, psState
, piDx
, pTabdef
, pbInClass
, pssa
);
258 if (1 > cString
|| NULL
== pString
) {
261 if ((dwFlags
& SSA_GLYPHS
) && NULL
== hdc
) {
268 /***********************************************************************
269 * ScriptStringFree (USP10.@)
272 HRESULT WINAPI
ScriptStringFree(SCRIPT_STRING_ANALYSIS
*pssa
) {
273 FIXME("(%p): stub\n",pssa
);
277 /***********************************************************************
278 * ScriptIsComplex (USP10.@)
281 HRESULT WINAPI
ScriptIsComplex(const WCHAR
* pwcInChars
, int cInChars
, DWORD dwFlags
) {
282 FIXME("(%s,%d,0x%lx): stub\n", debugstr_w(pwcInChars
), cInChars
, dwFlags
);
285 /***********************************************************************
286 * ScriptShape (USP10.@)
289 HRESULT WINAPI
ScriptShape(HDC hdc
, SCRIPT_CACHE
*psc
, const WCHAR
*pwcChars
,
290 int cChars
, int cMaxGlyphs
,
291 SCRIPT_ANALYSIS
*psa
, WORD
*pwOutGlyphs
, WORD
*pwLogClust
,
292 SCRIPT_VISATTR
*psva
, int *pcGlyphs
)
294 /* Note SCRIPT_CACHE (*psc) appears to be a good place to save info that needs to be
295 * passed between functions. */
301 Scriptcache
*pScriptcache
;
303 FIXME("(%p, %p, %p, %d, %d, %p): semi-stub\n", hdc
, psc
, pwcChars
,
304 cChars
, cMaxGlyphs
, psa
);
305 if (psa
) TRACE("%d, %d, %d, %d, %d, %d, %d\n", psa
->eScript
, psa
->fRTL
, psa
->fLayoutRTL
,
306 psa
->fLinkBefore
, psa
->fLinkAfter
,
307 psa
->fLogicalOrder
, psa
->fNoGlyphIndex
);
309 if (cChars
> cMaxGlyphs
) return E_OUTOFMEMORY
;
312 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc
, *psc
);
316 pScriptcache
= HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache
) );
317 pScriptcache
->hdc
= (HDC
) hdc
;
319 pScriptcache
->HaveWidths
= 0;
320 *psc
= (Scriptcache
*) pScriptcache
;
323 pScriptcache
= (Scriptcache
*) *psc
;
324 phdc
= pScriptcache
->hdc
;
328 for (cnt
= 0; cnt
< cChars
; cnt
++)
329 TRACE("%4x",pwcChars
[cnt
]);
332 if (!psa
->fNoGlyphIndex
) { /* Glyph translate */
333 hr
= GetGlyphIndicesW(phdc
, pwcChars
, cChars
, pwOutGlyphs
, 0);
335 for (cnt
= 0; cnt
< cChars
; cnt
++) {
336 TRACE("%04x",pwOutGlyphs
[cnt
]);
337 pScriptcache
->GlyphToChar
[pwOutGlyphs
[cnt
]] = pwcChars
[cnt
]; /* save for ScriptPlace */
343 for (cnt
= 0; cnt
< cChars
; cnt
++) { /* no translate so set up */
344 pwOutGlyphs
[cnt
] = pwcChars
[cnt
]; /* copy in to out and */
345 TRACE("%04x",pwOutGlyphs
[cnt
]);
346 pScriptcache
->GlyphToChar
[pwcChars
[cnt
]] = pwcChars
[cnt
]; /* set up a dummy table */
351 /* Set up a valid SCRIPT_VISATTR for this run */
352 clusterinit
= 1; /* Start of Cluster */
353 for (cnt
= 0; cnt
< cChars
; cnt
++) {
354 psva
[cnt
].uJustification
= 0;
355 psva
[cnt
].fClusterStart
= clusterinit
;
357 psva
[cnt
].fDiacritic
= 0;
358 psva
[cnt
].fZeroWidth
= 0;
363 /***********************************************************************
364 * ScriptPlace (USP10.@)
367 HRESULT WINAPI
ScriptPlace(HDC hdc
, SCRIPT_CACHE
*psc
, const WORD
*pwGlyphs
,
368 int cGlyphs
, const SCRIPT_VISATTR
*psva
,
369 SCRIPT_ANALYSIS
*psa
, int *piAdvance
, GOFFSET
*pGoffset
, ABC
*pABC
)
374 Scriptcache
*pScriptcache
;
375 FIXME("(%p, %p, %p, %s, %d, %p, %p, %p): semi-stub\n", hdc
, psc
, pwGlyphs
,
376 debugstr_w(pwGlyphs
),
380 /* We need a valid hdc to do any of the font calls. The spec says that hdc is optional and
381 * psc will be used first. If psc and hdc are not specified E_PENDING is returned to get
382 * the caller to return the hdc. For convience, the hdc is cached in SCRIPT_CACHE. */
385 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc
, *psc
);
389 pScriptcache
= HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache
) );
390 pScriptcache
->hdc
= hdc
;
396 phdc
= pScriptcache
->hdc
;
399 /* Here we need to calculate the width of the run unit. At this point the input string
400 * has been converted to glyphs and we till need to translate back to the original chars
401 * to get the correct ABC widths. To make life easier the ABC widths are saved in the
402 * SCRIPT_CACHE. This is ok as the cache must be invalidated if the font or font size
405 lpABC
= pScriptcache
->CharWidths
;
409 if (!pScriptcache
->HaveWidths
) {
410 if (GetCharABCWidthsW(phdc
, 0, 255, lpABC
))
411 pScriptcache
->HaveWidths
= 1;
413 WARN("Could not get ABC values\n");
417 for (wcnt
= 0; wcnt
< cGlyphs
; wcnt
++) { /* add up the char lengths */
418 TRACE(" Glyph=%04x, abcA=%d, abcB=%d, abcC=%d wcnt=%d\n",
420 lpABC
[pScriptcache
->GlyphToChar
[pwGlyphs
[wcnt
]]].abcA
,
421 lpABC
[pScriptcache
->GlyphToChar
[pwGlyphs
[wcnt
]]].abcB
,
422 lpABC
[pScriptcache
->GlyphToChar
[pwGlyphs
[wcnt
]]].abcC
, wcnt
);
423 pABC
->abcA
+= lpABC
[pScriptcache
->GlyphToChar
[pwGlyphs
[wcnt
]]].abcA
;
424 pABC
->abcB
+= lpABC
[pScriptcache
->GlyphToChar
[pwGlyphs
[wcnt
]]].abcB
;
425 pABC
->abcC
+= lpABC
[pScriptcache
->GlyphToChar
[pwGlyphs
[wcnt
]]].abcC
;
427 TRACE("Total for run: abcA=%d, abcB=%d, abcC=%d\n", pABC
->abcA
, pABC
->abcB
, pABC
->abcC
);
432 /***********************************************************************
433 * ScriptGetCMap (USP10.@)
436 /***********************************************************************
437 * ScriptGetCMap (USP10.@)
440 HRESULT WINAPI
ScriptGetCMap(HDC hdc
, SCRIPT_CACHE
*psc
, const WCHAR
*pwcInChars
,
441 int cChars
, DWORD dwFlags
, WORD
*pwOutGlyphs
)
446 Scriptcache
*pScriptcache
;
447 FIXME("(%p,%p,%s,%d,0x%lx,%p): semi-stub\n", hdc
, psc
, debugstr_wn(pwcInChars
,cChars
), cChars
, dwFlags
, pwOutGlyphs
);
450 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc
, *psc
);
454 pScriptcache
= HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache
) );
455 pScriptcache
->hdc
= hdc
;
457 pScriptcache
->HaveWidths
= 0;
462 phdc
= pScriptcache
->hdc
;
466 for (cnt
= 0; cnt
< cChars
; cnt
++)
467 TRACE("%4x",pwcInChars
[cnt
]);
470 hr
= GetGlyphIndicesW(phdc
, pwcInChars
, cChars
, pwOutGlyphs
, 0);
472 for (cnt
= 0; cnt
< cChars
; cnt
++) {
473 TRACE("%04x",pwOutGlyphs
[cnt
]);
474 pScriptcache
->GlyphToChar
[pwOutGlyphs
[cnt
]] = pwcInChars
[cnt
]; /* save for ScriptPlace */
481 /***********************************************************************
482 * ScriptTextOut (USP10.@)
485 HRESULT WINAPI
ScriptTextOut(const HDC hdc
, SCRIPT_CACHE
*psc
, int x
, int y
, UINT fuOptions
,
486 const RECT
*lprc
, const SCRIPT_ANALYSIS
*psa
, const WCHAR
*pwcReserved
,
487 int iReserved
, const WORD
*pwGlyphs
, int cGlyphs
, const int *piAdvance
,
488 const int *piJustify
, const GOFFSET
*pGoffset
)
490 FIXME("(%p, %p, %d, %d, %04x, %p, %p, %p, %d, %p, %d, %p, %p, %p): stub\n",
491 hdc
, psc
, x
, y
, fuOptions
, lprc
, psa
, pwcReserved
, iReserved
, pwGlyphs
, cGlyphs
,
492 piAdvance
, piJustify
, pGoffset
);