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 const char* arabic_GSUB_features
[] =
208 static INT
GSUB_is_glyph_covered(LPCVOID table
, UINT glyph
)
210 const GSUB_CoverageFormat1
* cf1
;
214 if (GET_BE_WORD(cf1
->CoverageFormat
) == 1)
216 int count
= GET_BE_WORD(cf1
->GlyphCount
);
218 TRACE("Coverage Format 1, %i glyphs\n",count
);
219 for (i
= 0; i
< count
; i
++)
220 if (glyph
== GET_BE_WORD(cf1
->GlyphArray
[i
]))
224 else if (GET_BE_WORD(cf1
->CoverageFormat
) == 2)
226 const GSUB_CoverageFormat2
* cf2
;
229 cf2
= (const GSUB_CoverageFormat2
*)cf1
;
231 count
= GET_BE_WORD(cf2
->RangeCount
);
232 TRACE("Coverage Format 2, %i ranges\n",count
);
233 for (i
= 0; i
< count
; i
++)
235 if (glyph
< GET_BE_WORD(cf2
->RangeRecord
[i
].Start
))
237 if ((glyph
>= GET_BE_WORD(cf2
->RangeRecord
[i
].Start
)) &&
238 (glyph
<= GET_BE_WORD(cf2
->RangeRecord
[i
].End
)))
240 return (GET_BE_WORD(cf2
->RangeRecord
[i
].StartCoverageIndex
) +
241 glyph
- GET_BE_WORD(cf2
->RangeRecord
[i
].Start
));
247 ERR("Unknown CoverageFormat %i\n",GET_BE_WORD(cf1
->CoverageFormat
));
252 static const GSUB_Script
* GSUB_get_script_table( const GSUB_Header
* header
, const char* tag
)
254 const GSUB_ScriptList
*script
;
255 const GSUB_Script
*deflt
= NULL
;
257 script
= (const GSUB_ScriptList
*)((const BYTE
*)header
+ GET_BE_WORD(header
->ScriptList
));
259 TRACE("%i scripts in this font\n",GET_BE_WORD(script
->ScriptCount
));
260 for (i
= 0; i
< GET_BE_WORD(script
->ScriptCount
); i
++)
262 const GSUB_Script
*scr
;
265 offset
= GET_BE_WORD(script
->ScriptRecord
[i
].Script
);
266 scr
= (const GSUB_Script
*)((const BYTE
*)script
+ offset
);
268 if (strncmp(script
->ScriptRecord
[i
].ScriptTag
, tag
,4)==0)
270 if (strncmp(script
->ScriptRecord
[i
].ScriptTag
, "dflt",4)==0)
276 static const GSUB_LangSys
* GSUB_get_lang_table( const GSUB_Script
* script
, const char* tag
)
280 const GSUB_LangSys
*Lang
;
282 TRACE("Deflang %x, LangCount %i\n",GET_BE_WORD(script
->DefaultLangSys
), GET_BE_WORD(script
->LangSysCount
));
284 for (i
= 0; i
< GET_BE_WORD(script
->LangSysCount
) ; i
++)
286 offset
= GET_BE_WORD(script
->LangSysRecord
[i
].LangSys
);
287 Lang
= (const GSUB_LangSys
*)((const BYTE
*)script
+ offset
);
289 if ( strncmp(script
->LangSysRecord
[i
].LangSysTag
,tag
,4)==0)
292 offset
= GET_BE_WORD(script
->DefaultLangSys
);
295 Lang
= (const GSUB_LangSys
*)((const BYTE
*)script
+ offset
);
301 static const GSUB_Feature
* GSUB_get_feature(const GSUB_Header
*header
, const GSUB_LangSys
*lang
, const char* tag
)
304 const GSUB_FeatureList
*feature
;
305 feature
= (const GSUB_FeatureList
*)((const BYTE
*)header
+ GET_BE_WORD(header
->FeatureList
));
307 TRACE("%i features\n",GET_BE_WORD(lang
->FeatureCount
));
308 for (i
= 0; i
< GET_BE_WORD(lang
->FeatureCount
); i
++)
310 int index
= GET_BE_WORD(lang
->FeatureIndex
[i
]);
311 if (strncmp(feature
->FeatureRecord
[index
].FeatureTag
,tag
,4)==0)
313 const GSUB_Feature
*feat
;
314 feat
= (const GSUB_Feature
*)((const BYTE
*)feature
+ GET_BE_WORD(feature
->FeatureRecord
[index
].Feature
));
321 static INT
GSUB_apply_SingleSubst(const GSUB_LookupTable
*look
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
324 TRACE("Single Substitution Subtable\n");
326 for (j
= 0; j
< GET_BE_WORD(look
->SubTableCount
); j
++)
329 const GSUB_SingleSubstFormat1
*ssf1
;
330 offset
= GET_BE_WORD(look
->SubTable
[j
]);
331 ssf1
= (const GSUB_SingleSubstFormat1
*)((const BYTE
*)look
+offset
);
332 if (GET_BE_WORD(ssf1
->SubstFormat
) == 1)
334 int offset
= GET_BE_WORD(ssf1
->Coverage
);
335 TRACE(" subtype 1, delta %i\n", GET_BE_WORD(ssf1
->DeltaGlyphID
));
336 if (GSUB_is_glyph_covered((const BYTE
*)ssf1
+offset
, glyphs
[glyph_index
]) != -1)
338 TRACE(" Glyph 0x%x ->",glyphs
[glyph_index
]);
339 glyphs
[glyph_index
] = glyphs
[glyph_index
] + GET_BE_WORD(ssf1
->DeltaGlyphID
);
340 TRACE(" 0x%x\n",glyphs
[glyph_index
]);
341 return glyph_index
+ 1;
346 const GSUB_SingleSubstFormat2
*ssf2
;
350 ssf2
= (const GSUB_SingleSubstFormat2
*)ssf1
;
351 offset
= GET_BE_WORD(ssf1
->Coverage
);
352 TRACE(" subtype 2, glyph count %i\n", GET_BE_WORD(ssf2
->GlyphCount
));
353 index
= GSUB_is_glyph_covered((const BYTE
*)ssf2
+offset
, glyphs
[glyph_index
]);
354 TRACE(" Coverage index %i\n",index
);
357 TRACE(" Glyph is 0x%x ->",glyphs
[glyph_index
]);
358 glyphs
[glyph_index
] = GET_BE_WORD(ssf2
->Substitute
[index
]);
359 TRACE("0x%x\n",glyphs
[glyph_index
]);
360 return glyph_index
+ 1;
364 return GSUB_E_NOGLYPH
;
367 static INT
GSUB_apply_LigatureSubst(const GSUB_LookupTable
*look
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
371 TRACE("Ligature Substitution Subtable\n");
372 for (j
= 0; j
< GET_BE_WORD(look
->SubTableCount
); j
++)
374 const GSUB_LigatureSubstFormat1
*lsf1
;
377 offset
= GET_BE_WORD(look
->SubTable
[j
]);
378 lsf1
= (const GSUB_LigatureSubstFormat1
*)((const BYTE
*)look
+offset
);
379 offset
= GET_BE_WORD(lsf1
->Coverage
);
380 index
= GSUB_is_glyph_covered((const BYTE
*)lsf1
+offset
, glyphs
[glyph_index
]);
381 TRACE(" Coverage index %i\n",index
);
384 const GSUB_LigatureSet
*ls
;
387 offset
= GET_BE_WORD(lsf1
->LigatureSet
[index
]);
388 ls
= (const GSUB_LigatureSet
*)((const BYTE
*)lsf1
+offset
);
389 count
= GET_BE_WORD(ls
->LigatureCount
);
390 TRACE(" LigatureSet has %i members\n",count
);
391 for (k
= 0; k
< count
; k
++)
393 const GSUB_Ligature
*lig
;
394 int CompCount
,l
,CompIndex
;
396 offset
= GET_BE_WORD(ls
->Ligature
[k
]);
397 lig
= (const GSUB_Ligature
*)((const BYTE
*)ls
+offset
);
398 CompCount
= GET_BE_WORD(lig
->CompCount
) - 1;
399 CompIndex
= glyph_index
+write_dir
;
400 for (l
= 0; l
< CompCount
&& CompIndex
>= 0 && CompIndex
< *glyph_count
; l
++)
403 CompGlyph
= GET_BE_WORD(lig
->Component
[l
]);
404 if (CompGlyph
!= glyphs
[CompIndex
])
406 CompIndex
+= write_dir
;
410 int replaceIdx
= glyph_index
;
412 replaceIdx
= glyph_index
- CompCount
;
414 TRACE(" Glyph is 0x%x (+%i) ->",glyphs
[glyph_index
],CompCount
);
415 glyphs
[replaceIdx
] = GET_BE_WORD(lig
->LigGlyph
);
416 TRACE("0x%x\n",glyphs
[replaceIdx
]);
420 for (j
= replaceIdx
+ 1; j
< *glyph_count
; j
++)
421 glyphs
[j
] =glyphs
[j
+CompCount
];
422 *glyph_count
= *glyph_count
- CompCount
;
424 return replaceIdx
+ 1;
429 return GSUB_E_NOGLYPH
;
432 static INT
GSUB_apply_lookup(const GSUB_LookupList
* lookup
, INT lookup_index
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
435 const GSUB_LookupTable
*look
;
437 offset
= GET_BE_WORD(lookup
->Lookup
[lookup_index
]);
438 look
= (const GSUB_LookupTable
*)((const BYTE
*)lookup
+ offset
);
439 TRACE("type %i, flag %x, subtables %i\n",GET_BE_WORD(look
->LookupType
),GET_BE_WORD(look
->LookupFlag
),GET_BE_WORD(look
->SubTableCount
));
440 switch(GET_BE_WORD(look
->LookupType
))
443 return GSUB_apply_SingleSubst(look
, glyphs
, glyph_index
, write_dir
, glyph_count
);
445 return GSUB_apply_LigatureSubst(look
, glyphs
, glyph_index
, write_dir
, glyph_count
);
447 FIXME("We do not handle SubType %i\n",GET_BE_WORD(look
->LookupType
));
449 return GSUB_E_NOGLYPH
;
452 static INT
GSUB_apply_feature(const GSUB_Header
* header
, const GSUB_Feature
* feature
, WORD
*glyphs
, INT glyph_index
, INT write_dir
, INT
*glyph_count
)
455 int out_index
= GSUB_E_NOGLYPH
;
456 const GSUB_LookupList
*lookup
;
458 lookup
= (const GSUB_LookupList
*)((const BYTE
*)header
+ GET_BE_WORD(header
->LookupList
));
460 TRACE("%i lookups\n", GET_BE_WORD(feature
->LookupCount
));
461 for (i
= 0; i
< GET_BE_WORD(feature
->LookupCount
); i
++)
463 out_index
= GSUB_apply_lookup(lookup
, GET_BE_WORD(feature
->LookupListIndex
[i
]), glyphs
, glyph_index
, write_dir
, glyph_count
);
464 if (out_index
!= GSUB_E_NOGLYPH
)
467 if (out_index
== GSUB_E_NOGLYPH
)
468 TRACE("lookups found no glyphs\n");
472 static const char* get_opentype_script(HDC hdc
, SCRIPT_ANALYSIS
*psa
)
476 switch (psa
->eScript
)
492 * fall back to the font charset
494 charset
= GetTextCharsetInfo(hdc
, NULL
, 0x0);
497 case ANSI_CHARSET
: return "latn";
498 case BALTIC_CHARSET
: return "latn"; /* ?? */
499 case CHINESEBIG5_CHARSET
: return "hani";
500 case EASTEUROPE_CHARSET
: return "latn"; /* ?? */
501 case GB2312_CHARSET
: return "hani";
502 case GREEK_CHARSET
: return "grek";
503 case HANGUL_CHARSET
: return "hang";
504 case RUSSIAN_CHARSET
: return "cyrl";
505 case SHIFTJIS_CHARSET
: return "kana";
506 case TURKISH_CHARSET
: return "latn"; /* ?? */
507 case VIETNAMESE_CHARSET
: return "latn";
508 case JOHAB_CHARSET
: return "latn"; /* ?? */
509 case ARABIC_CHARSET
: return "arab";
510 case HEBREW_CHARSET
: return "hebr";
511 case THAI_CHARSET
: return "thai";
512 default: return "latn";
516 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
)
518 const GSUB_Header
*header
;
519 const GSUB_Script
*script
;
520 const GSUB_LangSys
*language
;
521 const GSUB_Feature
*feature
;
524 return GSUB_E_NOFEATURE
;
528 script
= GSUB_get_script_table(header
, get_opentype_script(hdc
,psa
));
531 TRACE("Script not found\n");
532 return GSUB_E_NOFEATURE
;
534 language
= GSUB_get_lang_table(script
, "xxxx"); /* Need to get Lang tag */
537 TRACE("Language not found\n");
538 return GSUB_E_NOFEATURE
;
540 feature
= GSUB_get_feature(header
, language
, feat
);
543 TRACE("%s feature not found\n",feat
);
544 return GSUB_E_NOFEATURE
;
546 TRACE("applying feature %s\n",feat
);
547 return GSUB_apply_feature(header
, feature
, glyphs
, index
, write_dir
, glyph_count
);
550 static VOID
*load_gsub_table(HDC hdc
)
552 VOID
* GSUB_Table
= NULL
;
553 int length
= GetFontData(hdc
, GSUB_TAG
, 0, NULL
, 0);
554 if (length
!= GDI_ERROR
)
556 GSUB_Table
= HeapAlloc(GetProcessHeap(),0,length
);
557 GetFontData(hdc
, GSUB_TAG
, 0, GSUB_Table
, length
);
558 TRACE("Loaded GSUB table of %i bytes\n",length
);
563 static int apply_GSUB_feature(HDC hdc
, SCRIPT_ANALYSIS
*psa
, void* GSUB_Table
, WORD
*pwOutGlyphs
, int write_dir
, INT
* pcGlyphs
, const char* feat
)
569 const GSUB_Header
*header
;
570 const GSUB_Script
*script
;
571 const GSUB_LangSys
*language
;
572 const GSUB_Feature
*feature
;
575 return GSUB_E_NOFEATURE
;
579 script
= GSUB_get_script_table(header
, get_opentype_script(hdc
,psa
));
582 TRACE("Script not found\n");
583 return GSUB_E_NOFEATURE
;
585 language
= GSUB_get_lang_table(script
, "xxxx");
588 TRACE("Language not found\n");
589 return GSUB_E_NOFEATURE
;
591 feature
= GSUB_get_feature(header
, language
, feat
);
594 TRACE("%s feature not found\n",feat
);
595 return GSUB_E_NOFEATURE
;
599 TRACE("applying feature %s\n",feat
);
603 nextIndex
= GSUB_apply_feature(header
, feature
, pwOutGlyphs
, i
, write_dir
, pcGlyphs
);
604 if (nextIndex
> GSUB_E_NOGLYPH
)
611 return GSUB_E_NOFEATURE
;
614 static CHAR
neighbour_joining_type(int i
, int delta
, const CHAR
* context_type
, INT cchLen
, SCRIPT_ANALYSIS
*psa
)
618 if (psa
->fLinkBefore
)
623 if ( i
+ delta
>= cchLen
)
633 if (context_type
[i
] == jtT
)
634 return neighbour_joining_type(i
,delta
,context_type
,cchLen
,psa
);
636 return context_type
[i
];
639 static inline BOOL
right_join_causing(CHAR joining_type
)
641 return (joining_type
== jtL
|| joining_type
== jtD
|| joining_type
== jtC
);
644 static inline BOOL
left_join_causing(CHAR joining_type
)
646 return (joining_type
== jtR
|| joining_type
== jtD
|| joining_type
== jtC
);
649 /* SHAPE_ShapeArabicGlyphs
651 void SHAPE_ShapeArabicGlyphs(HDC hdc
, ScriptCache
*psc
, SCRIPT_ANALYSIS
*psa
, WCHAR
* pwcChars
, INT cChars
, WORD
* pwOutGlyphs
, INT
* pcGlyphs
, INT cMaxGlyphs
)
658 if (psa
->eScript
!= Script_Arabic
)
661 if (*pcGlyphs
!= cChars
)
663 ERR("Number of Glyphs and Chars need to match at the beginning\n");
668 if (!psa
->fLogicalOrder
&& psa
->fRTL
)
679 if (!psc
->GSUB_Table
)
680 psc
->GSUB_Table
= load_gsub_table(hdc
);
682 context_type
= HeapAlloc(GetProcessHeap(),0,cChars
);
683 context_shape
= HeapAlloc(GetProcessHeap(),0,sizeof(INT
) * cChars
);
685 for (i
= 0; i
< cChars
; i
++)
686 context_type
[i
] = wine_shaping_table
[wine_shaping_table
[pwcChars
[i
] >> 8] + (pwcChars
[i
] & 0xff)];
688 for (i
= 0; i
< cChars
; i
++)
690 if (context_type
[i
] == jtR
&& right_join_causing(neighbour_joining_type(i
,dirR
,context_type
,cChars
,psa
)))
691 context_shape
[i
] = Xr
;
692 else if (context_type
[i
] == jtL
&& left_join_causing(neighbour_joining_type(i
,dirL
,context_type
,cChars
,psa
)))
693 context_shape
[i
] = Xl
;
694 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
)))
695 context_shape
[i
] = Xm
;
696 else if (context_type
[i
] == jtD
&& right_join_causing(neighbour_joining_type(i
,dirR
,context_type
,cChars
,psa
)))
697 context_shape
[i
] = Xr
;
698 else if (context_type
[i
] == jtD
&& left_join_causing(neighbour_joining_type(i
,dirL
,context_type
,cChars
,psa
)))
699 context_shape
[i
] = Xl
;
701 context_shape
[i
] = Xn
;
704 /* Contextual Shaping */
713 nextIndex
= apply_GSUB_feature_to_glyph(hdc
, psa
, psc
->GSUB_Table
, pwOutGlyphs
, i
, dirL
, pcGlyphs
, contextual_features
[context_shape
[i
]]);
714 if (nextIndex
> GSUB_E_NOGLYPH
)
716 shaped
= (nextIndex
> GSUB_E_NOGLYPH
);
721 WORD newGlyph
= pwOutGlyphs
[i
];
722 if (pwcChars
[i
] >= FIRST_ARABIC_CHAR
&& pwcChars
[i
] <= LAST_ARABIC_CHAR
)
724 /* fall back to presentation form B */
725 WCHAR context_char
= wine_shaping_forms
[pwcChars
[i
] - FIRST_ARABIC_CHAR
][context_shape
[i
]];
726 if (context_char
!= pwcChars
[i
] && GetGlyphIndicesW(hdc
, &context_char
, 1, &newGlyph
, 0) != GDI_ERROR
&& newGlyph
!= 0x0000)
727 pwOutGlyphs
[i
] = newGlyph
;
734 while (arabic_GSUB_features
[i
] != NULL
)
736 apply_GSUB_feature(hdc
, psa
, psc
->GSUB_Table
, pwOutGlyphs
, dirL
, pcGlyphs
, arabic_GSUB_features
[i
]);
740 HeapFree(GetProcessHeap(),0,context_shape
);
741 HeapFree(GetProcessHeap(),0,context_type
);