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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 {
75 /***********************************************************************
79 BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID lpv)
82 case DLL_PROCESS_ATTACH:
83 DisableThreadLibraryCalls(hInstDLL);
85 case DLL_PROCESS_DETACH:
91 /***********************************************************************
92 * ScriptFreeCache (USP10.@)
95 HRESULT WINAPI ScriptFreeCache(SCRIPT_CACHE *psc)
100 HeapFree ( GetProcessHeap(), 0, *psc);
106 /***********************************************************************
107 * ScriptGetProperties (USP10.@)
110 HRESULT WINAPI ScriptGetProperties(const SCRIPT_PROPERTIES ***ppSp, int *piNumScripts)
112 TRACE("%p,%p\n", ppSp, piNumScripts);
114 if (!ppSp && !piNumScripts) return E_INVALIDARG;
116 /* Set up a sensible default and intialise pointers */
117 if (piNumScripts) *piNumScripts = MAX_SCRIPTS;
118 if (ppSp) *ppSp = Global_Script;
119 TRACE("ppSp:%p, *ppSp:%p, **ppSp:%p, %d\n",
120 ppSp, ppSp ? *ppSp : NULL, (ppSp && *ppSp) ? **ppSp : NULL,
121 piNumScripts ? *piNumScripts : -1);
125 /***********************************************************************
126 * ScriptGetFontProperties (USP10.@)
129 HRESULT WINAPI ScriptGetFontProperties(HDC hdc, SCRIPT_CACHE *psc, SCRIPT_FONTPROPERTIES *sfp)
132 Scriptcache *pScriptcache;
135 TRACE("%p,%p,%p\n", hdc, psc, sfp);
140 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
144 pScriptcache = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(Scriptcache) );
145 pScriptcache->hdc = (HDC) hdc;
147 *psc = (Scriptcache *) pScriptcache;
150 pScriptcache = (Scriptcache *) *psc;
151 phdc = pScriptcache->hdc;
154 if (sfp->cBytes != sizeof(SCRIPT_FONTPROPERTIES))
157 /* return something sensible? */
159 if (GetTextMetricsW(phdc, &ptm))
160 sfp->wgDefault = ptm.tmDefaultChar;
164 sfp->wgKashida = 0xffff;
165 sfp->iKashidaWidth = 0;
169 /***********************************************************************
170 * ScriptRecordDigitSubstitution (USP10.@)
173 HRESULT WINAPI ScriptRecordDigitSubstitution(LCID Locale,SCRIPT_DIGITSUBSTITUTE *psds)
175 FIXME("%ld,%p\n",Locale,psds);
179 /***********************************************************************
180 * ScriptApplyDigitSubstitution (USP10.@)
183 HRESULT WINAPI ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE* psds,
184 SCRIPT_CONTROL* psc, SCRIPT_STATE* pss)
186 FIXME("%p,%p,%p\n",psds,psc,pss);
190 /***********************************************************************
191 * ScriptItemize (USP10.@)
194 HRESULT WINAPI ScriptItemize(const WCHAR *pwcInChars, int cInChars, int cMaxItems,
195 const SCRIPT_CONTROL *psControl, const SCRIPT_STATE *psState,
196 SCRIPT_ITEM *pItems, int *pcItems)
198 /* This implementation currently treats the entire string represented in
199 * pwcInChars as a single entity. Hence pcItems will be set to 1. */
201 FIXME("%s,%d,%d,%p,%p,%p,%p: semi-stub\n", debugstr_wn(pwcInChars, cInChars), cInChars, cMaxItems,
202 psControl, psState, pItems, pcItems);
204 if (!pwcInChars || !cInChars || !pItems || cMaxItems < 2)
207 /* Set a sensible default */
208 /* Set SCRIPT_ITEM */
209 pItems[0].iCharPos = 0;
210 /* Set the SCRIPT_ANALYSIS */
211 pItems[0].a.eScript = SCRIPT_UNDEFINED;
212 pItems[0].a.fRTL = 0;
213 pItems[0].a.fLayoutRTL = 0;
214 pItems[0].a.fLinkBefore = 0;
215 pItems[0].a.fLinkAfter = 0;
216 pItems[0].a.fLogicalOrder = 0;
217 pItems[0].a.fNoGlyphIndex = 0;
218 /* set the SCRIPT_STATE */
219 pItems[0].a.s.uBidiLevel = 0;
220 pItems[0].a.s.fOverrideDirection = 0;
221 pItems[0].a.s.fInhibitSymSwap = FALSE;
222 pItems[0].a.s.fCharShape = 0;
223 pItems[0].a.s.fDigitSubstitute = 0;
224 pItems[0].a.s.fInhibitLigate = 0;
225 pItems[0].a.s.fDisplayZWG = 0;
226 pItems[0].a.s.fArabicNumContext = 0;
227 pItems[0].a.s.fGcpClusters = 0;
228 pItems[0].a.s.fReserved = 0;
229 pItems[0].a.s.fEngineReserved = 0;
231 /* While not strickly necessary according to the spec, make sure the n+1
232 * item is set up to prevent random behaviour if the caller eroneously
233 * checks the n+1 structure */
234 pItems[1].a.eScript = 0;
235 pItems[1].a.fRTL = 0;
236 pItems[1].a.fLayoutRTL = 0;
237 pItems[1].a.fLinkBefore = 0;
238 pItems[1].a.fLinkAfter = 0;
239 pItems[1].a.fLogicalOrder = 0;
240 pItems[1].a.fNoGlyphIndex = 0;
241 /* set the SCRIPT_STATE */
242 pItems[1].a.s.uBidiLevel = 0;
243 pItems[1].a.s.fOverrideDirection = 0;
244 pItems[1].a.s.fInhibitSymSwap = FALSE;
245 pItems[1].a.s.fCharShape = 0;
246 pItems[1].a.s.fDigitSubstitute = 0;
247 pItems[1].a.s.fInhibitLigate = 0;
248 pItems[1].a.s.fDisplayZWG = 0;
249 pItems[1].a.s.fArabicNumContext = 0;
250 pItems[1].a.s.fGcpClusters = 0;
251 pItems[1].a.s.fReserved = 0;
252 pItems[1].a.s.fEngineReserved = 0;
254 /* Set one SCRIPT_STATE item being returned */
257 /* Set SCRIPT_ITEM */
258 pItems[1].iCharPos = cInChars - pItems[0].iCharPos ; /* the last + 1 item
259 contains the ptr to the lastchar */
260 TRACE("%s,%d,%d,%p,%p,%p,%p,%d\n", debugstr_wn(pwcInChars, cInChars), cInChars, cMaxItems,
261 psControl, psState, pItems, pcItems, *pcItems);
262 TRACE("Start Pos in string: %d, Stop Pos %d\n", pItems[0].iCharPos, pItems[1].iCharPos);
266 /***********************************************************************
267 * ScriptStringAnalyse (USP10.@)
270 HRESULT WINAPI ScriptStringAnalyse(HDC hdc,
277 SCRIPT_CONTROL *psControl,
278 SCRIPT_STATE *psState,
280 SCRIPT_TABDEF *pTabdef,
281 const BYTE *pbInClass,
282 SCRIPT_STRING_ANALYSIS *pssa)
284 FIXME("(%p,%p,%d,%d,%d,0x%lx,%d,%p,%p,%p,%p,%p,%p): stub\n",
285 hdc, pString, cString, cGlyphs, iCharset, dwFlags,
286 iReqWidth, psControl, psState, piDx, pTabdef, pbInClass, pssa);
287 if (1 > cString || NULL == pString) {
290 if ((dwFlags & SSA_GLYPHS) && NULL == hdc) {
297 /***********************************************************************
298 * ScriptStringOut (USP10.@)
301 HRESULT WINAPI ScriptStringOut(SCRIPT_STRING_ANALYSIS ssa,
310 FIXME("(%p,%d,%d,0x%1x,%p,%d,%d,%d): stub\n",
311 ssa, iX, iY, uOptions, prc, iMinSel, iMaxSel, fDisabled);
319 /***********************************************************************
320 * ScriptStringCPtoX (USP10.@)
323 HRESULT WINAPI ScriptStringCPtoX(SCRIPT_STRING_ANALYSIS ssa, int icp, BOOL fTrailing, int* pX)
325 FIXME("(%p), %d, %d, (%p): stub\n", ssa, icp, fTrailing, pX);
326 *pX = 0; /* Set a reasonable value */
330 /***********************************************************************
331 * ScriptStringXtoCP (USP10.@)
334 HRESULT WINAPI ScriptStringXtoCP(SCRIPT_STRING_ANALYSIS ssa, int iX, int* piCh, int* piTrailing)
336 FIXME("(%p), %d, (%p), (%p): stub\n", ssa, iX, piCh, piTrailing);
337 *piCh = 0; /* Set a reasonable value */
342 /***********************************************************************
343 * ScriptStringFree (USP10.@)
346 HRESULT WINAPI ScriptStringFree(SCRIPT_STRING_ANALYSIS *pssa) {
347 FIXME("(%p): stub\n",pssa);
351 /***********************************************************************
352 * ScriptCPtoX (USP10.@)
355 HRESULT WINAPI ScriptCPtoX(int iCP,
359 const WORD *pwLogClust,
360 const SCRIPT_VISATTR *psva,
361 const int *piAdvance,
362 const SCRIPT_ANALYSIS *psa,
368 TRACE("(%d,%d,%d,%d,%p,%p,%p,%p,%p)\n",
369 iCP, fTrailing, cChars, cGlyphs, pwLogClust, psva, piAdvance,
371 for (item=0; item < cGlyphs; item++) /* total piAdvance */
372 fMaxPosX += piAdvance[item];
373 iPosX = (fMaxPosX/cGlyphs)*(iCP+fTrailing);
374 if (iPosX > fMaxPosX)
376 *piX = iPosX; /* Return something in range */
378 TRACE("*piX=%d\n", *piX);
382 /***********************************************************************
383 * ScriptXtoCP (USP10.@)
386 HRESULT WINAPI ScriptXtoCP(int iX,
389 const WORD *pwLogClust,
390 const SCRIPT_VISATTR *psva,
391 const int *piAdvance,
392 const SCRIPT_ANALYSIS *psa,
400 TRACE("(%d,%d,%d,%p,%p,%p,%p,%p,%p)\n",
401 iX, cChars, cGlyphs, pwLogClust, psva, piAdvance,
402 psa, piCP, piTrailing);
403 if (iX < 0) /* iX is before start of run */
410 for (item=0; item < cGlyphs; item++) /* total piAdvance */
411 fMaxPosX += piAdvance[item];
413 if (iX >= fMaxPosX) /* iX too large */
420 fAvePosX = fMaxPosX / cGlyphs;
421 for (item = 0; item < cGlyphs && iPosX < iX; item++)
422 iPosX = fAvePosX * (item +1);
423 if (iPosX - iX > fAvePosX/2)
426 *piTrailing = 1; /* yep we are over half way */
428 *piCP = item -1; /* Return character position */
429 TRACE("*piCP=%d iPposX=%d\n", *piCP, iPosX);
433 /***********************************************************************
434 * ScriptBreak (USP10.@)
437 HRESULT WINAPI ScriptBreak(const WCHAR *pwcChars, int cChars, const SCRIPT_ANALYSIS *psa,
438 SCRIPT_LOGATTR *psla)
440 FIXME("(%p,%d,%p,%p): stub\n",
441 pwcChars, cChars, psa, psla);
446 /***********************************************************************
447 * ScriptIsComplex (USP10.@)
450 HRESULT WINAPI ScriptIsComplex(const WCHAR* pwcInChars, int cInChars, DWORD dwFlags) {
451 FIXME("(%s,%d,0x%lx): stub\n", debugstr_wn(pwcInChars, cInChars), cInChars, dwFlags);
455 /***********************************************************************
456 * ScriptShape (USP10.@)
459 HRESULT WINAPI ScriptShape(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcChars,
460 int cChars, int cMaxGlyphs,
461 SCRIPT_ANALYSIS *psa, WORD *pwOutGlyphs, WORD *pwLogClust,
462 SCRIPT_VISATTR *psva, int *pcGlyphs)
464 /* Note SCRIPT_CACHE (*psc) appears to be a good place to save info that needs to be
465 * passed between functions. */
470 Scriptcache *pScriptcache;
472 FIXME("(%p, %p, %p, %d, %d, %p): semi-stub\n", hdc, psc, pwcChars,
473 cChars, cMaxGlyphs, psa);
474 if (psa) TRACE("psa values: %d, %d, %d, %d, %d, %d, %d\n", psa->eScript, psa->fRTL, psa->fLayoutRTL,
475 psa->fLinkBefore, psa->fLinkAfter,
476 psa->fLogicalOrder, psa->fNoGlyphIndex);
478 if (cChars > cMaxGlyphs) return E_OUTOFMEMORY;
481 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
485 pScriptcache = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(Scriptcache) );
486 pScriptcache->hdc = (HDC) hdc;
488 *psc = (Scriptcache *) pScriptcache;
491 pScriptcache = (Scriptcache *) *psc;
492 phdc = pScriptcache->hdc;
496 for (cnt = 0; cnt < cChars; cnt++)
497 TRACE("%4x",pwcChars[cnt]);
500 if (!psa->fNoGlyphIndex) { /* Glyph translate */
501 hr = GetGlyphIndicesW(phdc, pwcChars, cChars, pwOutGlyphs, 0);
503 for (cnt = 0; cnt < cChars; cnt++) {
504 TRACE("%04x",pwOutGlyphs[cnt]);
510 for (cnt = 0; cnt < cChars; cnt++) { /* no translate so set up */
511 pwOutGlyphs[cnt] = pwcChars[cnt]; /* copy in to out and */
512 TRACE("%04x",pwOutGlyphs[cnt]);
517 /* Set up a valid SCRIPT_VISATTR and LogClust for each char in this run */
518 for (cnt = 0; cnt < cChars; cnt++) {
519 psva[cnt].uJustification = 2;
520 psva[cnt].fClusterStart = 1;
521 psva[cnt].fDiacritic = 0;
522 psva[cnt].fZeroWidth = 0;
523 pwLogClust[cnt] = cnt;
528 /***********************************************************************
529 * ScriptPlace (USP10.@)
532 HRESULT WINAPI ScriptPlace(HDC hdc, SCRIPT_CACHE *psc, const WORD *pwGlyphs,
533 int cGlyphs, const SCRIPT_VISATTR *psva,
534 SCRIPT_ANALYSIS *psa, int *piAdvance, GOFFSET *pGoffset, ABC *pABC )
539 Scriptcache *pScriptcache;
540 FIXME("(%p, %p, %p, %s, %d, %p, %p, %p): semi-stub\n", hdc, psc, pwGlyphs,
541 debugstr_wn(pwGlyphs, cGlyphs),
545 /* We need a valid hdc to do any of the font calls. The spec says that hdc is optional and
546 * psc will be used first. If psc and hdc are not specified E_PENDING is returned to get
547 * the caller to return the hdc. For convience, the hdc is cached in SCRIPT_CACHE. */
550 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
554 pScriptcache = HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache) );
555 pScriptcache->hdc = hdc;
561 phdc = pScriptcache->hdc;
564 /* Here we need to calculate the width of the run unit. At this point the input string
565 * has been converted to glyphs and we till need to translate back to the original chars
566 * to get the correct ABC widths. */
568 lpABC = HeapAlloc(GetProcessHeap(), 0 , sizeof(ABC)*cGlyphs);
572 if (!GetCharABCWidthsI(phdc, 0, cGlyphs, (WORD *) pwGlyphs, lpABC ))
574 WARN("Could not get ABC values\n");
575 for (wcnt = 0; wcnt < cGlyphs; wcnt++) {
577 pGoffset[wcnt].du = 0;
578 pGoffset[wcnt].dv = 0;
583 for (wcnt = 0; wcnt < cGlyphs ; wcnt++) { /* add up the char lengths */
584 TRACE(" Glyph=%04x, abcA=%d, abcB=%d, abcC=%d wcnt=%d\n",
588 lpABC[wcnt].abcC, wcnt);
589 pABC->abcA += lpABC[wcnt].abcA;
590 pABC->abcB += lpABC[wcnt].abcB;
591 pABC->abcC += lpABC[wcnt].abcC;
592 piAdvance[wcnt] = lpABC[wcnt].abcA + lpABC[wcnt].abcB + lpABC[wcnt].abcC;
593 pGoffset[wcnt].du = 0;
594 pGoffset[wcnt].dv = 0;
597 TRACE("Total for run: abcA=%d, abcB=%d, abcC=%d\n", pABC->abcA, pABC->abcB, pABC->abcC);
599 HeapFree(GetProcessHeap(), 0, lpABC );
604 /***********************************************************************
605 * ScriptGetCMap (USP10.@)
608 HRESULT WINAPI ScriptGetCMap(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcInChars,
609 int cChars, DWORD dwFlags, WORD *pwOutGlyphs)
614 Scriptcache *pScriptcache;
615 FIXME("(%p,%p,%s,%d,0x%lx,%p): semi-stub\n", hdc, psc, debugstr_wn(pwcInChars,cChars),
616 cChars, dwFlags, pwOutGlyphs);
622 TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
626 pScriptcache = HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache) );
627 pScriptcache->hdc = hdc;
633 phdc = pScriptcache->hdc;
637 for (cnt = 0; cnt < cChars; cnt++)
638 TRACE("%4x",pwcInChars[cnt]);
641 hr = GetGlyphIndicesW(phdc, pwcInChars, cChars, pwOutGlyphs, 0);
643 for (cnt = 0; cnt < cChars; cnt++) {
644 TRACE("%04x",pwOutGlyphs[cnt]);
651 /***********************************************************************
652 * ScriptTextOut (USP10.@)
655 HRESULT WINAPI ScriptTextOut(const HDC hdc, SCRIPT_CACHE *psc, int x, int y, UINT fuOptions,
656 const RECT *lprc, const SCRIPT_ANALYSIS *psa, const WCHAR *pwcReserved,
657 int iReserved, const WORD *pwGlyphs, int cGlyphs, const int *piAdvance,
658 const int *piJustify, const GOFFSET *pGoffset)
662 Scriptcache *pScriptcache;
663 TRACE ("(%p, %p, %d, %d, %04x, %p, %p, %p, %d, %p, %d, %p, %p, %p): stub\n",
664 hdc, psc, x, y, fuOptions, lprc, psa, pwcReserved, iReserved, pwGlyphs, cGlyphs,
665 piAdvance, piJustify, pGoffset);
667 if (!hdc || !psc || !piAdvance || !psa || !pwGlyphs) /* hdc is mandatory */
671 pScriptcache = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(Scriptcache) );
672 pScriptcache->hdc = hdc;
677 phdc = pScriptcache->hdc;
680 fuOptions &= ETO_CLIPPED + ETO_OPAQUE;
681 if (!psa->fNoGlyphIndex) /* Have Glyphs? */
682 fuOptions |= ETO_GLYPH_INDEX; /* Say don't do tranlastion to glyph */
684 hr = ExtTextOutW(phdc, x, y, fuOptions, lprc, pwGlyphs, cGlyphs, NULL);
688 FIXME("ExtTextOut returned:=%ld\n", hr);
693 /***********************************************************************
694 * ScriptCacheGetHeight (USP10.@)
696 * Retrieve the height of the font in the cache.
699 * hdc [I] Device context.
700 * psc [I/O] Opaque pointer to a script cache.
701 * height [O] Receives font height.
705 * Failure: Non-zero HRESULT value.
707 HRESULT WINAPI ScriptCacheGetHeight(HDC hdc, SCRIPT_CACHE *psc, long *height)
710 Scriptcache *pScriptcache;
713 TRACE("(%p, %p, %p)\n", hdc, psc, height);
718 if (!hdc) return E_PENDING;
721 pScriptcache = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(Scriptcache));
722 pScriptcache->hdc = hdc;
727 phdc = pScriptcache->hdc;
730 /* FIXME: get this from the cache */
731 if (!GetTextMetricsW(phdc, &metric))
734 *height = metric.tmHeight;