2 * Implementation of Shaping for the Uniscribe Script Processor (usp10.dll)
4 * Copyright 2010 CodeWeavers, Aric Stewart
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
31 #include "usp10_internal.h"
33 #include "wine/debug.h"
35 WINE_DEFAULT_DEBUG_CHANNEL(uniscribe
);
37 #define FIRST_ARABIC_CHAR 0x0600
38 #define LAST_ARABIC_CHAR 0x06ff
40 extern const unsigned short wine_shaping_table
[];
41 extern const unsigned short wine_shaping_forms
[LAST_ARABIC_CHAR
- FIRST_ARABIC_CHAR
+ 1][4];
59 #ifdef WORDS_BIGENDIAN
60 #define GET_BE_WORD(x) (x)
62 #define GET_BE_WORD(x) RtlUshortByteSwap(x)
65 /* These are all structures needed for the GSUB table */
66 #define MS_MAKE_TAG( _x1, _x2, _x3, _x4 ) \
67 ( ( (ULONG)_x4 << 24 ) | \
68 ( (ULONG)_x3 << 16 ) | \
69 ( (ULONG)_x2 << 8 ) | \
72 #define GSUB_TAG MS_MAKE_TAG('G', 'S', 'U', 'B')
73 #define GSUB_E_NOFEATURE -2
74 #define GSUB_E_NOGLYPH -1
90 GSUB_ScriptRecord ScriptRecord
[1];
101 GSUB_LangSysRecord LangSysRecord
[1];
105 WORD LookupOrder
; /* Reserved */
106 WORD ReqFeatureIndex
;
108 WORD FeatureIndex
[1];
114 } GSUB_FeatureRecord
;
118 GSUB_FeatureRecord FeatureRecord
[1];
122 WORD FeatureParams
; /* Reserved */
124 WORD LookupListIndex
[1];
143 } GSUB_CoverageFormat1
;
148 WORD StartCoverageIndex
;
154 GSUB_RangeRecord RangeRecord
[1];
155 } GSUB_CoverageFormat2
;
158 WORD SubstFormat
; /* = 1 */
161 } GSUB_SingleSubstFormat1
;
164 WORD SubstFormat
; /* = 2 */
168 }GSUB_SingleSubstFormat2
;
171 WORD SubstFormat
; /* = 1 */
175 }GSUB_LigatureSubstFormat1
;
188 /* the orders of joined_forms and contextual_features need to line up */
189 static const char* contextual_features
[] =
197 static INT
GSUB_is_glyph_covered(LPCVOID table
, UINT glyph
)
199 const GSUB_CoverageFormat1
* cf1
;
203 if (GET_BE_WORD(cf1
->CoverageFormat
) == 1)
205 int count
= GET_BE_WORD(cf1
->GlyphCount
);
207 TRACE("Coverage Format 1, %i glyphs\n",count
);
208 for (i
= 0; i
< count
; i
++)
209 if (glyph
== GET_BE_WORD(cf1
->GlyphArray
[i
]))
213 else if (GET_BE_WORD(cf1
->CoverageFormat
) == 2)
215 const GSUB_CoverageFormat2
* cf2
;
218 cf2
= (const GSUB_CoverageFormat2
*)cf1
;
220 count
= GET_BE_WORD(cf2
->RangeCount
);
221 TRACE("Coverage Format 2, %i ranges\n",count
);
222 for (i
= 0; i
< count
; i
++)
224 if (glyph
< GET_BE_WORD(cf2
->RangeRecord
[i
].Start
))
226 if ((glyph
>= GET_BE_WORD(cf2
->RangeRecord
[i
].Start
)) &&
227 (glyph
<= GET_BE_WORD(cf2
->RangeRecord
[i
].End
)))
229 return (GET_BE_WORD(cf2
->RangeRecord
[i
].StartCoverageIndex
) +
230 glyph
- GET_BE_WORD(cf2
->RangeRecord
[i
].Start
));
236 ERR("Unknown CoverageFormat %i\n",GET_BE_WORD(cf1
->CoverageFormat
));
241 static const GSUB_Script
* GSUB_get_script_table( const GSUB_Header
* header
, const char* tag
)
243 const GSUB_ScriptList
*script
;
244 const GSUB_Script
*deflt
= NULL
;
246 script
= (const GSUB_ScriptList
*)((const BYTE
*)header
+ GET_BE_WORD(header
->ScriptList
));
248 TRACE("%i scripts in this font\n",GET_BE_WORD(script
->ScriptCount
));
249 for (i
= 0; i
< GET_BE_WORD(script
->ScriptCount
); i
++)
251 const GSUB_Script
*scr
;
254 offset
= GET_BE_WORD(script
->ScriptRecord
[i
].Script
);
255 scr
= (const GSUB_Script
*)((const BYTE
*)script
+ offset
);
257 if (strncmp(script
->ScriptRecord
[i
].ScriptTag
, tag
,4)==0)
259 if (strncmp(script
->ScriptRecord
[i
].ScriptTag
, "dflt",4)==0)
265 static const GSUB_LangSys
* GSUB_get_lang_table( const GSUB_Script
* script
, const char* tag
)
269 const GSUB_LangSys
*Lang
;
271 TRACE("Deflang %x, LangCount %i\n",GET_BE_WORD(script
->DefaultLangSys
), GET_BE_WORD(script
->LangSysCount
));
273 for (i
= 0; i
< GET_BE_WORD(script
->LangSysCount
) ; i
++)
275 offset
= GET_BE_WORD(script
->LangSysRecord
[i
].LangSys
);
276 Lang
= (const GSUB_LangSys
*)((const BYTE
*)script
+ offset
);
278 if ( strncmp(script
->LangSysRecord
[i
].LangSysTag
,tag
,4)==0)
281 offset
= GET_BE_WORD(script
->DefaultLangSys
);
284 Lang
= (const GSUB_LangSys
*)((const BYTE
*)script
+ offset
);
290 static const GSUB_Feature
* GSUB_get_feature(const GSUB_Header
*header
, const GSUB_LangSys
*lang
, const char* tag
)
293 const GSUB_FeatureList
*feature
;
294 feature
= (const GSUB_FeatureList
*)((const BYTE
*)header
+ GET_BE_WORD(header
->FeatureList
));
296 TRACE("%i features\n",GET_BE_WORD(lang
->FeatureCount
));
297 for (i
= 0; i
< GET_BE_WORD(lang
->FeatureCount
); i
++)
299 int index
= GET_BE_WORD(lang
->FeatureIndex
[i
]);
300 if (strncmp(feature
->FeatureRecord
[index
].FeatureTag
,tag
,4)==0)
302 const GSUB_Feature
*feat
;
303 feat
= (const GSUB_Feature
*)((const BYTE
*)feature
+ GET_BE_WORD(feature
->FeatureRecord
[index
].Feature
));
310 static INT
GSUB_apply_SingleSubst(const GSUB_LookupTable
*look
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
313 TRACE("Single Substitution Subtable\n");
315 for (j
= 0; j
< GET_BE_WORD(look
->SubTableCount
); j
++)
318 const GSUB_SingleSubstFormat1
*ssf1
;
319 offset
= GET_BE_WORD(look
->SubTable
[j
]);
320 ssf1
= (const GSUB_SingleSubstFormat1
*)((const BYTE
*)look
+offset
);
321 if (GET_BE_WORD(ssf1
->SubstFormat
) == 1)
323 int offset
= GET_BE_WORD(ssf1
->Coverage
);
324 TRACE(" subtype 1, delta %i\n", GET_BE_WORD(ssf1
->DeltaGlyphID
));
325 if (GSUB_is_glyph_covered((const BYTE
*)ssf1
+offset
, glyphs
[glyph_index
]) != -1)
327 TRACE(" Glyph 0x%x ->",glyphs
[glyph_index
]);
328 glyphs
[glyph_index
] = glyphs
[glyph_index
] + GET_BE_WORD(ssf1
->DeltaGlyphID
);
329 TRACE(" 0x%x\n",glyphs
[glyph_index
]);
330 return glyph_index
+ 1;
335 const GSUB_SingleSubstFormat2
*ssf2
;
339 ssf2
= (const GSUB_SingleSubstFormat2
*)ssf1
;
340 offset
= GET_BE_WORD(ssf1
->Coverage
);
341 TRACE(" subtype 2, glyph count %i\n", GET_BE_WORD(ssf2
->GlyphCount
));
342 index
= GSUB_is_glyph_covered((const BYTE
*)ssf2
+offset
, glyphs
[glyph_index
]);
343 TRACE(" Coverage index %i\n",index
);
346 TRACE(" Glyph is 0x%x ->",glyphs
[glyph_index
]);
347 glyphs
[glyph_index
] = GET_BE_WORD(ssf2
->Substitute
[index
]);
348 TRACE("0x%x\n",glyphs
[glyph_index
]);
349 return glyph_index
+ 1;
353 return GSUB_E_NOGLYPH
;
356 static INT
GSUB_apply_LigatureSubst(const GSUB_LookupTable
*look
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
360 TRACE("Ligature Substitution Subtable\n");
361 for (j
= 0; j
< GET_BE_WORD(look
->SubTableCount
); j
++)
363 const GSUB_LigatureSubstFormat1
*lsf1
;
366 offset
= GET_BE_WORD(look
->SubTable
[j
]);
367 lsf1
= (const GSUB_LigatureSubstFormat1
*)((const BYTE
*)look
+offset
);
368 offset
= GET_BE_WORD(lsf1
->Coverage
);
369 index
= GSUB_is_glyph_covered((const BYTE
*)lsf1
+offset
, glyphs
[glyph_index
]);
370 TRACE(" Coverage index %i\n",index
);
373 const GSUB_LigatureSet
*ls
;
376 offset
= GET_BE_WORD(lsf1
->LigatureSet
[index
]);
377 ls
= (const GSUB_LigatureSet
*)((const BYTE
*)lsf1
+offset
);
378 count
= GET_BE_WORD(ls
->LigatureCount
);
379 TRACE(" LigatureSet has %i members\n",count
);
380 for (k
= 0; k
< count
; k
++)
382 const GSUB_Ligature
*lig
;
383 int CompCount
,l
,CompIndex
;
385 offset
= GET_BE_WORD(ls
->Ligature
[k
]);
386 lig
= (const GSUB_Ligature
*)((const BYTE
*)ls
+offset
);
387 CompCount
= GET_BE_WORD(lig
->CompCount
) - 1;
388 CompIndex
= glyph_index
+write_dir
;
389 for (l
= 0; l
< CompCount
&& CompIndex
>= 0 && CompIndex
< *glyph_count
; l
++)
392 CompGlyph
= GET_BE_WORD(lig
->Component
[l
]);
393 if (CompGlyph
!= glyphs
[CompIndex
])
395 CompIndex
+= write_dir
;
399 int replaceIdx
= glyph_index
;
401 replaceIdx
= glyph_index
- CompCount
;
403 TRACE(" Glyph is 0x%x (+%i) ->",glyphs
[glyph_index
],CompCount
);
404 glyphs
[replaceIdx
] = GET_BE_WORD(lig
->LigGlyph
);
405 TRACE("0x%x\n",glyphs
[replaceIdx
]);
409 for (j
= replaceIdx
+ 1; j
< *glyph_count
; j
++)
410 glyphs
[j
] =glyphs
[j
+CompCount
];
411 *glyph_count
= *glyph_count
- CompCount
;
413 return replaceIdx
+ 1;
418 return GSUB_E_NOGLYPH
;
421 static INT
GSUB_apply_lookup(const GSUB_LookupList
* lookup
, INT lookup_index
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
424 const GSUB_LookupTable
*look
;
426 offset
= GET_BE_WORD(lookup
->Lookup
[lookup_index
]);
427 look
= (const GSUB_LookupTable
*)((const BYTE
*)lookup
+ offset
);
428 TRACE("type %i, flag %x, subtables %i\n",GET_BE_WORD(look
->LookupType
),GET_BE_WORD(look
->LookupFlag
),GET_BE_WORD(look
->SubTableCount
));
429 switch(GET_BE_WORD(look
->LookupType
))
432 return GSUB_apply_SingleSubst(look
, glyphs
, glyph_index
, write_dir
, glyph_count
);
434 return GSUB_apply_LigatureSubst(look
, glyphs
, glyph_index
, write_dir
, glyph_count
);
436 FIXME("We do not handle SubType %i\n",GET_BE_WORD(look
->LookupType
));
438 return GSUB_E_NOGLYPH
;
441 static INT
GSUB_apply_feature(const GSUB_Header
* header
, const GSUB_Feature
* feature
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
444 int out_index
= GSUB_E_NOGLYPH
;
445 const GSUB_LookupList
*lookup
;
447 lookup
= (const GSUB_LookupList
*)((const BYTE
*)header
+ GET_BE_WORD(header
->LookupList
));
449 TRACE("%i lookups\n", GET_BE_WORD(feature
->LookupCount
));
450 for (i
= 0; i
< GET_BE_WORD(feature
->LookupCount
); i
++)
452 out_index
= GSUB_apply_lookup(lookup
, GET_BE_WORD(feature
->LookupListIndex
[i
]), glyphs
, glyph_index
, write_dir
, glyph_count
);
453 if (out_index
!= GSUB_E_NOGLYPH
)
456 if (out_index
== GSUB_E_NOGLYPH
)
457 TRACE("lookups found no glyphs\n");
461 static const char* get_opentype_script(HDC hdc
, SCRIPT_ANALYSIS
*psa
)
465 switch (psa
->eScript
)
481 * fall back to the font charset
483 charset
= GetTextCharsetInfo(hdc
, NULL
, 0x0);
486 case ANSI_CHARSET
: return "latn";
487 case BALTIC_CHARSET
: return "latn"; /* ?? */
488 case CHINESEBIG5_CHARSET
: return "hani";
489 case EASTEUROPE_CHARSET
: return "latn"; /* ?? */
490 case GB2312_CHARSET
: return "hani";
491 case GREEK_CHARSET
: return "grek";
492 case HANGUL_CHARSET
: return "hang";
493 case RUSSIAN_CHARSET
: return "cyrl";
494 case SHIFTJIS_CHARSET
: return "kana";
495 case TURKISH_CHARSET
: return "latn"; /* ?? */
496 case VIETNAMESE_CHARSET
: return "latn";
497 case JOHAB_CHARSET
: return "latn"; /* ?? */
498 case ARABIC_CHARSET
: return "arab";
499 case HEBREW_CHARSET
: return "hebr";
500 case THAI_CHARSET
: return "thai";
501 default: return "latn";
505 static INT
apply_GSUB_feature_to_glyph(HDC hdc
, SCRIPT_ANALYSIS
*psa
, void* GSUB_Table
, WORD
*glyphs
, INT index
, INT write_dir
, INT
* glyph_count
, const char* feat
)
507 const GSUB_Header
*header
;
508 const GSUB_Script
*script
;
509 const GSUB_LangSys
*language
;
510 const GSUB_Feature
*feature
;
513 return GSUB_E_NOFEATURE
;
517 script
= GSUB_get_script_table(header
, get_opentype_script(hdc
,psa
));
520 TRACE("Script not found\n");
521 return GSUB_E_NOFEATURE
;
523 language
= GSUB_get_lang_table(script
, "xxxx"); /* Need to get Lang tag */
526 TRACE("Language not found\n");
527 return GSUB_E_NOFEATURE
;
529 feature
= GSUB_get_feature(header
, language
, feat
);
532 TRACE("%s feature not found\n",feat
);
533 return GSUB_E_NOFEATURE
;
535 TRACE("applying feature %s\n",feat
);
536 return GSUB_apply_feature(header
, feature
, glyphs
, index
, write_dir
, glyph_count
);
539 static VOID
*load_gsub_table(HDC hdc
)
541 VOID
* GSUB_Table
= NULL
;
542 int length
= GetFontData(hdc
, GSUB_TAG
, 0, NULL
, 0);
543 if (length
!= GDI_ERROR
)
545 GSUB_Table
= HeapAlloc(GetProcessHeap(),0,length
);
546 GetFontData(hdc
, GSUB_TAG
, 0, GSUB_Table
, length
);
547 TRACE("Loaded GSUB table of %i bytes\n",length
);
552 static CHAR
neighbour_joining_type(int i
, int delta
, const CHAR
* context_type
, INT cchLen
, SCRIPT_ANALYSIS
*psa
)
556 if (psa
->fLinkBefore
)
561 if ( i
+ delta
>= cchLen
)
571 if (context_type
[i
] == jtT
)
572 return neighbour_joining_type(i
,delta
,context_type
,cchLen
,psa
);
574 return context_type
[i
];
577 static inline BOOL
right_join_causing(CHAR joining_type
)
579 return (joining_type
== jtL
|| joining_type
== jtD
|| joining_type
== jtC
);
582 static inline BOOL
left_join_causing(CHAR joining_type
)
584 return (joining_type
== jtR
|| joining_type
== jtD
|| joining_type
== jtC
);
587 /* SHAPE_ShapeArabicGlyphs
589 void SHAPE_ShapeArabicGlyphs(HDC hdc
, ScriptCache
*psc
, SCRIPT_ANALYSIS
*psa
, WCHAR
* pwcChars
, INT cChars
, WORD
* pwOutGlyphs
, INT
* pcGlyphs
, INT cMaxGlyphs
)
596 if (psa
->eScript
!= Script_Arabic
)
599 if (*pcGlyphs
!= cChars
)
601 ERR("Number of Glyphs and Chars need to match at the beginning\n");
606 if (!psa
->fLogicalOrder
&& psa
->fRTL
)
617 if (!psc
->GSUB_Table
)
618 psc
->GSUB_Table
= load_gsub_table(hdc
);
620 context_type
= HeapAlloc(GetProcessHeap(),0,cChars
);
621 context_shape
= HeapAlloc(GetProcessHeap(),0,sizeof(INT
) * cChars
);
623 for (i
= 0; i
< cChars
; i
++)
624 context_type
[i
] = wine_shaping_table
[wine_shaping_table
[pwcChars
[i
] >> 8] + (pwcChars
[i
] & 0xff)];
626 for (i
= 0; i
< cChars
; i
++)
628 if (context_type
[i
] == jtR
&& right_join_causing(neighbour_joining_type(i
,dirR
,context_type
,cChars
,psa
)))
629 context_shape
[i
] = Xr
;
630 else if (context_type
[i
] == jtL
&& left_join_causing(neighbour_joining_type(i
,dirL
,context_type
,cChars
,psa
)))
631 context_shape
[i
] = Xl
;
632 else if (context_type
[i
] == jtD
&& left_join_causing(neighbour_joining_type(i
,dirL
,context_type
,cChars
,psa
)) && right_join_causing(neighbour_joining_type(i
,dirR
,context_type
,cChars
,psa
)))
633 context_shape
[i
] = Xm
;
634 else if (context_type
[i
] == jtD
&& right_join_causing(neighbour_joining_type(i
,dirR
,context_type
,cChars
,psa
)))
635 context_shape
[i
] = Xr
;
636 else if (context_type
[i
] == jtD
&& left_join_causing(neighbour_joining_type(i
,dirL
,context_type
,cChars
,psa
)))
637 context_shape
[i
] = Xl
;
639 context_shape
[i
] = Xn
;
642 /* Contextual Shaping */
651 nextIndex
= apply_GSUB_feature_to_glyph(hdc
, psa
, psc
->GSUB_Table
, pwOutGlyphs
, i
, dirL
, pcGlyphs
, contextual_features
[context_shape
[i
]]);
652 if (nextIndex
> GSUB_E_NOGLYPH
)
654 shaped
= (nextIndex
> GSUB_E_NOGLYPH
);
659 WORD newGlyph
= pwOutGlyphs
[i
];
660 if (pwcChars
[i
] >= FIRST_ARABIC_CHAR
&& pwcChars
[i
] <= LAST_ARABIC_CHAR
)
662 /* fall back to presentation form B */
663 WCHAR context_char
= wine_shaping_forms
[pwcChars
[i
] - FIRST_ARABIC_CHAR
][context_shape
[i
]];
664 if (context_char
!= pwcChars
[i
] && GetGlyphIndicesW(hdc
, &context_char
, 1, &newGlyph
, 0) != GDI_ERROR
&& newGlyph
!= 0x0000)
665 pwOutGlyphs
[i
] = newGlyph
;
671 /* Required ligature substitution */
678 nextIndex
= apply_GSUB_feature_to_glyph(hdc
, psa
, psc
->GSUB_Table
, pwOutGlyphs
, i
, dirL
, pcGlyphs
, "rlig");
679 if (nextIndex
> GSUB_E_NOGLYPH
)
681 else if (nextIndex
== GSUB_E_NOFEATURE
)
688 HeapFree(GetProcessHeap(),0,context_shape
);
689 HeapFree(GetProcessHeap(),0,context_type
);