git.oblomov.eu Git - wine/blob - dlls/usp10/usp10.c

   1 /*
   2  * Implementation of Uniscribe Script Processor (usp10.dll)
   3  *
   4  * Copyright 2005 Steven Edwards for CodeWeavers
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Notes:
  21  * Uniscribe allows for processing of complex scripts such as joining
  22  * and filtering characters and bi-directional text with custom line breaks.
  23  */
  24
  25 #include <stdarg.h>
  26
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "wingdi.h"
  30 #include "winuser.h"
  31 #include "usp10.h"
  32
  33 #include "wine/debug.h"
  34
  35 /**
  36  * some documentation here:
  37  *   http://www.microsoft.com/typography/developers/uniscribe/uniscribe.htm
  38  */
  39
  40 WINE_DEFAULT_DEBUG_CHANNEL(uniscribe);
  41
  42 #define MAX_SCRIPTS  8
  43
  44 /*  Set up a default for ScriptGetProperties    */
  45 static const SCRIPT_PROPERTIES Default_Script_0 = {0, 0, 0, 0, 0, 0, 0, 0,
  46                                             0, 0, 0, 0, 0, 0, 0};
  47 static const SCRIPT_PROPERTIES Default_Script_1 = {0, 0, 0, 0, 0, 0, 0, 0,
  48                                             0, 0, 0, 0, 0, 0, 0};
  49 static const SCRIPT_PROPERTIES Default_Script_2 = {0, 0, 0, 0, 0, 0, 0, 0,
  50                                             0, 0, 0, 0, 0, 0, 0};
  51 static const SCRIPT_PROPERTIES Default_Script_3 = {9, 0, 0, 0, 0, 0, 0, 0,
  52                                             0, 0, 0, 0, 0, 0, 0};
  53 static const SCRIPT_PROPERTIES Default_Script_4 = {9, 1, 0, 0, 0, 0, 0, 0,
  54                                             0, 0, 0, 0, 0, 0, 0};
  55 static const SCRIPT_PROPERTIES Default_Script_5 = {9, 0, 0, 0, 0, 0, 0, 0,
  56                                             0, 0, 0, 0, 1, 0, 0};
  57 static const SCRIPT_PROPERTIES Default_Script_6 = {9, 1, 0, 0, 0, 0, 0, 0,
  58                                             0, 0, 0, 0, 1, 0, 0};
  59 static const SCRIPT_PROPERTIES Default_Script_7 = {8, 0, 0, 0, 0, 161, 0, 0,
  60                                             0, 0, 0, 0, 0, 0, 0};
  61 static const SCRIPT_PROPERTIES *Global_Script[MAX_SCRIPTS] =
  62                                       {&Default_Script_0,
  63                                        &Default_Script_1,
  64                                        &Default_Script_2,
  65                                        &Default_Script_3,
  66                                        &Default_Script_4,
  67                                        &Default_Script_5,
  68                                        &Default_Script_6,
  69                                        &Default_Script_7};
  70
  71 typedef struct scriptcache {
  72        HDC hdc;
  73 } Scriptcache;
  74
  75 BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID lpv)
  76 {
  77     switch(fdwReason) {
  78         case DLL_PROCESS_ATTACH:
  79             DisableThreadLibraryCalls(hInstDLL);
  80             break;
  81         case DLL_PROCESS_DETACH:
  82             break;
  83     }
  84     return TRUE;
  85 }
  86
  87 /***********************************************************************
  88  *      ScriptFreeCache (USP10.@)
  89  *
  90  */
  91 HRESULT WINAPI ScriptFreeCache(SCRIPT_CACHE *psc)
  92 {
  93     TRACE("%p\n", psc);
  94
  95     if (psc) {
  96        HeapFree ( GetProcessHeap(), 0, *psc);
  97        *psc = NULL;
  98     }
  99     return 0;
 100 }
 101
 102 /***********************************************************************
 103  *      ScriptGetProperties (USP10.@)
 104  *
 105  */
 106 HRESULT WINAPI ScriptGetProperties(const SCRIPT_PROPERTIES ***ppSp, int *piNumScripts)
 107 {
 108     TRACE("%p,%p\n",ppSp, piNumScripts);
 109
 110 /*  Set up a sensible default and intialise pointers  */
 111     *piNumScripts = MAX_SCRIPTS;
 112     *ppSp =  Global_Script;
 113     TRACE("ppSp:%p, *ppSp:%p, **ppSp:%p, %d\n", ppSp, *ppSp, **ppSp,
 114                                                 *piNumScripts);
 115     return 0;
 116 }
 117
 118 /***********************************************************************
 119  *      ScriptGetFontProperties (USP10.@)
 120  *
 121  */
 122 HRESULT WINAPI ScriptGetFontProperties(HDC hdc, SCRIPT_CACHE *psc, SCRIPT_FONTPROPERTIES *sfp)
 123 {
 124     HDC phdc;
 125     Scriptcache *pScriptcache;
 126     TEXTMETRICW ptm;
 127
 128     TRACE("%p,%p,%p\n", hdc, psc, sfp);
 129     if  (!hdc && !*psc) {
 130         TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
 131         return E_PENDING;
 132     }   else
 133         if  (hdc && !*psc) {
 134             pScriptcache = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(Scriptcache) );
 135             pScriptcache->hdc = (HDC) hdc;
 136             phdc = hdc;
 137             *psc = (Scriptcache *) pScriptcache;
 138         }   else
 139             if  (*psc) {
 140                 pScriptcache = (Scriptcache *) *psc;
 141                 phdc = pScriptcache->hdc;
 142             }
 143
 144     if (sfp->cBytes != sizeof(SCRIPT_FONTPROPERTIES))
 145         return E_INVALIDARG;
 146
 147     /* return something sensible? */
 148     if (NULL != sfp) {
 149         sfp->wgBlank       = 0;
 150         if  (GetTextMetricsW(phdc, &ptm))
 151             sfp->wgDefault = ptm.tmDefaultChar;
 152         else
 153             sfp->wgDefault = 0;
 154         sfp->wgInvalid     = 0;
 155         sfp->wgKashida     = 0xffff;
 156         sfp->iKashidaWidth = 0;
 157     }
 158     return 0;
 159 }
 160
 161 /***********************************************************************
 162  *      ScriptRecordDigitSubstitution (USP10.@)
 163  *
 164  */
 165 HRESULT WINAPI ScriptRecordDigitSubstitution(LCID Locale,SCRIPT_DIGITSUBSTITUTE *psds)
 166 {
 167     FIXME("%ld,%p\n",Locale,psds);
 168     return E_NOTIMPL;
 169 }
 170
 171 /***********************************************************************
 172  *      ScriptApplyDigitSubstitution (USP10.@)
 173  *
 174  */
 175 HRESULT WINAPI ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE* psds,
 176                                             SCRIPT_CONTROL* psc, SCRIPT_STATE* pss)
 177 {
 178     FIXME("%p,%p,%p\n",psds,psc,pss);
 179     return E_NOTIMPL;
 180 }
 181
 182 /***********************************************************************
 183  *      ScriptItemize (USP10.@)
 184  *
 185  */
 186 HRESULT WINAPI ScriptItemize(const WCHAR *pwcInChars, int cInChars, int cMaxItems,
 187                              const SCRIPT_CONTROL *psControl, const SCRIPT_STATE *psState,
 188                              SCRIPT_ITEM *pItems, int *pcItems)
 189 {
 190     /* This implementation currently treats the entire string represented in
 191      * pwcInChars as a single entity.  Hence pcItems will be set to 1.          */
 192
 193     FIXME("%s,%d,%d,%p,%p,%p,%p: semi-stub\n", debugstr_wn(pwcInChars, cInChars), cInChars, cMaxItems,
 194           psControl, psState, pItems, pcItems);
 195
 196     if (!pwcInChars || !cInChars || !pItems || cMaxItems < 2)
 197         return E_INVALIDARG;
 198
 199     /*  Set a sensible default                              */
 200     /*  Set SCRIPT_ITEM                                     */
 201     pItems[0].iCharPos = 0;
 202     /*  Set the SCRIPT_ANALYSIS                             */
 203     pItems[0].a.eScript = SCRIPT_UNDEFINED;
 204     pItems[0].a.fRTL = 0;
 205     pItems[0].a.fLayoutRTL = 0;
 206     pItems[0].a.fLinkBefore = 0;
 207     pItems[0].a.fLinkAfter = 0;
 208     pItems[0].a.fLogicalOrder = 0;
 209     pItems[0].a.fNoGlyphIndex = 0;
 210     /*  set the SCRIPT_STATE                                */
 211     pItems[0].a.s.uBidiLevel = 0;
 212     pItems[0].a.s.fOverrideDirection = 0;
 213     pItems[0].a.s.fInhibitSymSwap = FALSE;
 214     pItems[0].a.s.fCharShape = 0;
 215     pItems[0].a.s.fDigitSubstitute = 0;
 216     pItems[0].a.s.fInhibitLigate = 0;
 217     pItems[0].a.s.fDisplayZWG = 0;
 218     pItems[0].a.s.fArabicNumContext = 0;
 219     pItems[0].a.s.fGcpClusters = 0;
 220     pItems[0].a.s.fReserved = 0;
 221     pItems[0].a.s.fEngineReserved = 0;
 222
 223     /* While not strickly necessary according to the spec, make sure the n+1
 224      * item is set up to prevent random behaviour if the caller eroneously
 225      * checks the n+1 structure                                              */
 226     pItems[1].a.eScript = 0;
 227     pItems[1].a.fRTL = 0;
 228     pItems[1].a.fLayoutRTL = 0;
 229     pItems[1].a.fLinkBefore = 0;
 230     pItems[1].a.fLinkAfter = 0;
 231     pItems[1].a.fLogicalOrder = 0;
 232     pItems[1].a.fNoGlyphIndex = 0;
 233     /*  set the SCRIPT_STATE                                */
 234     pItems[1].a.s.uBidiLevel = 0;
 235     pItems[1].a.s.fOverrideDirection = 0;
 236     pItems[1].a.s.fInhibitSymSwap = FALSE;
 237     pItems[1].a.s.fCharShape = 0;
 238     pItems[1].a.s.fDigitSubstitute = 0;
 239     pItems[1].a.s.fInhibitLigate = 0;
 240     pItems[1].a.s.fDisplayZWG = 0;
 241     pItems[1].a.s.fArabicNumContext = 0;
 242     pItems[1].a.s.fGcpClusters = 0;
 243     pItems[1].a.s.fReserved = 0;
 244     pItems[1].a.s.fEngineReserved = 0;
 245
 246     /*  Set one SCRIPT_STATE item being returned  */
 247     *pcItems = 1;
 248
 249     /*  Set SCRIPT_ITEM                                     */
 250     pItems[1].iCharPos = cInChars - pItems[0].iCharPos ; /* the last + 1 item
 251                                              contains the ptr to the lastchar */
 252     TRACE("%s,%d,%d,%p,%p,%p,%p,%d\n", debugstr_wn(pwcInChars, cInChars), cInChars, cMaxItems,
 253           psControl, psState, pItems, pcItems, *pcItems);
 254     TRACE("Start Pos in string: %d, Stop Pos %d\n", pItems[0].iCharPos, pItems[1].iCharPos);
 255     return 0;
 256 }
 257
 258 /***********************************************************************
 259  *      ScriptStringAnalyse (USP10.@)
 260  *
 261  */
 262 HRESULT WINAPI ScriptStringAnalyse(HDC hdc,
 263                                    const void *pString,
 264                                    int cString,
 265                                    int cGlyphs,
 266                                    int iCharset,
 267                                    DWORD dwFlags,
 268                                    int iReqWidth,
 269                                    SCRIPT_CONTROL *psControl,
 270                                    SCRIPT_STATE *psState,
 271                                    const int *piDx,
 272                                    SCRIPT_TABDEF *pTabdef,
 273                                    const BYTE *pbInClass,
 274                                    SCRIPT_STRING_ANALYSIS *pssa)
 275 {
 276   FIXME("(%p,%p,%d,%d,%d,0x%lx,%d,%p,%p,%p,%p,%p,%p): stub\n",
 277         hdc, pString, cString, cGlyphs, iCharset, dwFlags,
 278         iReqWidth, psControl, psState, piDx, pTabdef, pbInClass, pssa);
 279   if (1 > cString || NULL == pString) {
 280     return E_INVALIDARG;
 281   }
 282   if ((dwFlags & SSA_GLYPHS) && NULL == hdc) {
 283     return E_INVALIDARG;
 284   }
 285
 286   return E_NOTIMPL;
 287 }
 288
 289 /***********************************************************************
 290  *      ScriptStringFree (USP10.@)
 291  *
 292  */
 293 HRESULT WINAPI ScriptStringFree(SCRIPT_STRING_ANALYSIS *pssa) {
 294   FIXME("(%p): stub\n",pssa);
 295   return S_OK;
 296 }
 297
 298 /***********************************************************************
 299  *      ScriptIsComplex (USP10.@)
 300  *
 301  */
 302 HRESULT WINAPI ScriptIsComplex(const WCHAR* pwcInChars, int cInChars, DWORD dwFlags) {
 303   FIXME("(%s,%d,0x%lx): stub\n",  debugstr_wn(pwcInChars, cInChars), cInChars, dwFlags);
 304    return E_NOTIMPL;
 305 }
 306
 307 /***********************************************************************
 308  *      ScriptShape (USP10.@)
 309  *
 310  */
 311 HRESULT WINAPI ScriptShape(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcChars,
 312                            int cChars, int cMaxGlyphs,
 313                            SCRIPT_ANALYSIS *psa, WORD *pwOutGlyphs, WORD *pwLogClust,
 314                            SCRIPT_VISATTR *psva, int *pcGlyphs)
 315 {
 316     /*  Note SCRIPT_CACHE (*psc) appears to be a good place to save info that needs to be
 317      *  passed between functions.                                                         */
 318
 319     HDC phdc;
 320     int cnt;
 321     DWORD hr;
 322     Scriptcache *pScriptcache;
 323     *pcGlyphs = cChars;
 324     FIXME("(%p, %p, %p, %d, %d, %p): semi-stub\n",  hdc, psc, pwcChars,
 325                                        cChars, cMaxGlyphs, psa);
 326     if (psa) TRACE("psa values: %d, %d, %d, %d, %d, %d, %d\n", psa->eScript, psa->fRTL, psa->fLayoutRTL,
 327                                          psa->fLinkBefore, psa->fLinkAfter,
 328                                          psa->fLogicalOrder, psa->fNoGlyphIndex);
 329
 330     if  (cChars > cMaxGlyphs) return E_OUTOFMEMORY;
 331
 332     if  (!hdc && !*psc) {
 333         TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
 334         return E_PENDING;
 335     }   else
 336         if  (hdc && !*psc) {
 337             pScriptcache = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(Scriptcache) );
 338             pScriptcache->hdc = (HDC) hdc;
 339             phdc = hdc;
 340             *psc = (Scriptcache *) pScriptcache;
 341        }   else
 342             if  (*psc) {
 343                 pScriptcache = (Scriptcache *) *psc;
 344                 phdc = pScriptcache->hdc;
 345             }
 346
 347     TRACE("Before: ");
 348     for (cnt = 0; cnt < cChars; cnt++)
 349          TRACE("%4x",pwcChars[cnt]);
 350     TRACE("\n");
 351
 352     if  (!psa->fNoGlyphIndex) {                                         /* Glyph translate */
 353         hr = GetGlyphIndicesW(phdc, pwcChars, cChars, pwOutGlyphs, 0);
 354         TRACE("After:  ");
 355         for (cnt = 0; cnt < cChars; cnt++) {
 356              TRACE("%04x",pwOutGlyphs[cnt]);
 357         }
 358         TRACE("\n");
 359     }
 360     else {
 361         TRACE("After:  ");
 362         for (cnt = 0; cnt < cChars; cnt++) {                           /* no translate so set up */
 363              pwOutGlyphs[cnt] = pwcChars[cnt];                         /* copy in to out and     */
 364              TRACE("%04x",pwOutGlyphs[cnt]);
 365         }
 366        TRACE("\n");
 367     }
 368
 369     /*  Set up a valid SCRIPT_VISATTR and LogClust for each char in this run */
 370     for (cnt = 0;  cnt < cChars; cnt++) {
 371          psva[cnt].uJustification = 2;
 372          psva[cnt].fClusterStart = 1;
 373          psva[cnt].fDiacritic = 0;
 374          psva[cnt].fZeroWidth = 0;
 375          pwLogClust[cnt] = cnt;
 376     }
 377     return 0;
 378 }
 379
 380 /***********************************************************************
 381  *      ScriptPlace (USP10.@)
 382  *
 383  */
 384 HRESULT WINAPI ScriptPlace(HDC hdc, SCRIPT_CACHE *psc, const WORD *pwGlyphs,
 385                            int cGlyphs, const SCRIPT_VISATTR *psva,
 386                            SCRIPT_ANALYSIS *psa, int *piAdvance, GOFFSET *pGoffset, ABC *pABC )
 387 {
 388     HDC phdc;
 389     int wcnt;
 390     LPABC lpABC;
 391     Scriptcache *pScriptcache;
 392     FIXME("(%p, %p, %p, %s, %d, %p, %p, %p): semi-stub\n",  hdc, psc, pwGlyphs,
 393                                                 debugstr_wn(pwGlyphs, cGlyphs),
 394                                                 cGlyphs, psva, psa,
 395                                                 piAdvance);
 396
 397     /*  We need a valid hdc to do any of the font calls.  The spec says that hdc is optional and
 398      *  psc will be used first.  If psc and hdc are not specified E_PENDING is returned to get
 399      *  the caller to return the hdc.  For convience, the hdc is cached in SCRIPT_CACHE.    */
 400
 401     if  (!hdc && !*psc) {
 402         TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
 403         return E_PENDING;
 404     }   else
 405         if  (hdc && !*psc) {
 406             pScriptcache = HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache) );
 407             pScriptcache->hdc = hdc;
 408             phdc = hdc;
 409             *psc = pScriptcache;
 410         }   else
 411             if  (*psc) {
 412                 pScriptcache = *psc;
 413                 phdc = pScriptcache->hdc;
 414             }
 415
 416     /*   Here we need to calculate the width of the run unit.  At this point the input string
 417      *   has been converted to glyphs and we till need to translate back to the original chars
 418      *   to get the correct ABC widths.   */
 419
 420      lpABC = HeapAlloc(GetProcessHeap(), 0 , sizeof(ABC)*cGlyphs);
 421      pABC->abcA = 0;
 422      pABC->abcB = 0;
 423      pABC->abcC = 0;
 424      if  (!GetCharABCWidthsI(phdc, 0, cGlyphs, (WORD *) pwGlyphs, lpABC ))
 425      {
 426          WARN("Could not get ABC values\n");
 427          for (wcnt = 0; wcnt < cGlyphs; wcnt++) {
 428              piAdvance[wcnt] = 0;
 429              pGoffset[wcnt].du = 0;
 430              pGoffset[wcnt].dv = 0;
 431          }
 432      }
 433      else
 434      {
 435          for (wcnt = 0; wcnt < cGlyphs ; wcnt++) {          /* add up the char lengths  */
 436              TRACE("     Glyph=%04x,  abcA=%d,  abcB=%d,  abcC=%d  wcnt=%d\n",
 437                                   pwGlyphs[wcnt],
 438                                   lpABC[wcnt].abcA,
 439                                   lpABC[wcnt].abcB,
 440                                   lpABC[wcnt].abcC, wcnt);
 441              pABC->abcA += lpABC[wcnt].abcA;
 442              pABC->abcB += lpABC[wcnt].abcB;
 443              pABC->abcC += lpABC[wcnt].abcC;
 444              piAdvance[wcnt] = lpABC[wcnt].abcA + lpABC[wcnt].abcB + lpABC[wcnt].abcC;
 445              pGoffset[wcnt].du = 0;
 446              pGoffset[wcnt].dv = 0;
 447          }
 448      }
 449      TRACE("Total for run:   abcA=%d,  abcB=%d,  abcC=%d\n", pABC->abcA, pABC->abcB, pABC->abcC);
 450
 451      HeapFree(GetProcessHeap(), 0, lpABC );
 452
 453      return 0;
 454 }
 455
 456 /***********************************************************************
 457  *      ScriptGetCMap (USP10.@)
 458  *
 459  */
 460 HRESULT WINAPI ScriptGetCMap(HDC hdc, SCRIPT_CACHE *psc, const WCHAR *pwcInChars,
 461                               int cChars, DWORD dwFlags, WORD *pwOutGlyphs)
 462 {
 463     HDC phdc;
 464     int cnt;
 465     DWORD hr;
 466     Scriptcache *pScriptcache;
 467     FIXME("(%p,%p,%s,%d,0x%lx,%p): semi-stub\n", hdc, psc, debugstr_wn(pwcInChars,cChars), cChars, dwFlags, pwOutGlyphs);
 468
 469     if  (!hdc && !*psc) {
 470         TRACE("No Script_Cache (psc) and no hdc. Ask for one. Hdc=%p, psc=%p\n", hdc, *psc);
 471         return E_PENDING;
 472     }   else
 473         if  (hdc && !*psc) {
 474             pScriptcache = HeapAlloc( GetProcessHeap(), 0, sizeof(Scriptcache) );
 475             pScriptcache->hdc = hdc;
 476             phdc = hdc;
 477             *psc = pScriptcache;
 478         }   else
 479             if  (*psc) {
 480                 pScriptcache = *psc;
 481                 phdc = pScriptcache->hdc;
 482             }
 483
 484     TRACE("Before: ");
 485     for (cnt = 0; cnt < cChars; cnt++)
 486          TRACE("%4x",pwcInChars[cnt]);
 487     TRACE("\n");
 488
 489     hr = GetGlyphIndicesW(phdc, pwcInChars, cChars, pwOutGlyphs, 0);
 490     TRACE("After:  ");
 491     for (cnt = 0; cnt < cChars; cnt++) {
 492          TRACE("%04x",pwOutGlyphs[cnt]);
 493     }
 494     TRACE("\n");
 495
 496     return 0;
 497 }
 498
 499 /***********************************************************************
 500  *      ScriptTextOut (USP10.@)
 501  *
 502  */
 503 HRESULT WINAPI ScriptTextOut(const HDC hdc, SCRIPT_CACHE *psc, int x, int y, UINT fuOptions,
 504                              const RECT *lprc, const SCRIPT_ANALYSIS *psa, const WCHAR *pwcReserved,
 505                              int iReserved, const WORD *pwGlyphs, int cGlyphs, const int *piAdvance,
 506                              const int *piJustify, const GOFFSET *pGoffset)
 507 {
 508      FIXME("(%p, %p, %d, %d, %04x, %p, %p, %p, %d, %p, %d, %p, %p, %p): stub\n",
 509            hdc, psc, x, y, fuOptions, lprc, psa, pwcReserved, iReserved, pwGlyphs, cGlyphs,
 510            piAdvance, piJustify, pGoffset);
 511      return E_NOTIMPL;
 512 }