Release 1.5.29.
[wine] / dlls / usp10 / usp10_internal.h
1 /*
2  * Implementation of Uniscribe Script Processor (usp10.dll)
3  *
4  * Copyright 2010 CodeWeavers, Aric Stewart
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  *
20  */
21 #define MS_MAKE_TAG( _x1, _x2, _x3, _x4 ) \
22           ( ( (ULONG)_x4 << 24 ) |     \
23             ( (ULONG)_x3 << 16 ) |     \
24             ( (ULONG)_x2 <<  8 ) |     \
25               (ULONG)_x1         )
26
27
28 #define Script_Latin   1
29 #define Script_CR      2
30 #define Script_Numeric 3
31 #define Script_Control 4
32 #define Script_Punctuation 5
33 #define Script_Arabic  6
34 #define Script_Arabic_Numeric  7
35 #define Script_Hebrew  8
36 #define Script_Syriac  9
37 #define Script_Persian 10
38 #define Script_Thaana  11
39 #define Script_Greek   12
40 #define Script_Cyrillic   13
41 #define Script_Armenian 14
42 #define Script_Georgian 15
43 /* Unicode Chapter 10 */
44 #define Script_Sinhala 16
45 #define Script_Tibetan 17
46 #define Script_Tibetan_Numeric 18
47 #define Script_Phags_pa 19
48 /* Unicode Chapter 11 */
49 #define Script_Thai 20
50 #define Script_Thai_Numeric 21
51 #define Script_Lao 22
52 #define Script_Lao_Numeric 23
53 /* Unicode Chapter 9 */
54 #define Script_Devanagari 24
55 #define Script_Devanagari_Numeric 25
56 #define Script_Bengali 26
57 #define Script_Bengali_Numeric 27
58 #define Script_Bengali_Currency 28
59 #define Script_Gurmukhi 29
60 #define Script_Gurmukhi_Numeric 30
61 #define Script_Gujarati 31
62 #define Script_Gujarati_Numeric 32
63 #define Script_Gujarati_Currency 33
64 #define Script_Oriya 34
65 #define Script_Oriya_Numeric 35
66 #define Script_Tamil 36
67 #define Script_Tamil_Numeric 37
68 #define Script_Telugu 38
69 #define Script_Telugu_Numeric 39
70 #define Script_Kannada 40
71 #define Script_Kannada_Numeric 41
72 #define Script_Malayalam 42
73 #define Script_Malayalam_Numeric 43
74 /* More supplemental */
75 #define Script_Diacritical 44
76 #define Script_Punctuation2 45
77 #define Script_Numeric2 46
78 /* Unicode Chapter 11 continued */
79 #define Script_Myanmar 47
80 #define Script_Myanmar_Numeric 48
81 #define Script_Tai_Le 49
82 #define Script_New_Tai_Lue 50
83 #define Script_New_Tai_Lue_Numeric 51
84 #define Script_Khmer 52
85 #define Script_Khmer_Numeric 53
86 /* Unicode Chapter 12 */
87 #define Script_CJK_Han  54
88 #define Script_Ideograph  55
89 #define Script_Bopomofo 56
90 #define Script_Kana 57
91 #define Script_Hangul 58
92 #define Script_Yi 59
93 /* Unicode Chapter 13 */
94 #define Script_Ethiopic 60
95 #define Script_Ethiopic_Numeric 61
96 #define Script_Mongolian 62
97 #define Script_Mongolian_Numeric 63
98 #define Script_Tifinagh 64
99 #define Script_NKo 65
100 #define Script_Vai 66
101 #define Script_Vai_Numeric 67
102 #define Script_Cherokee 68
103 #define Script_Canadian 69
104 /* Unicode Chapter 14 */
105 #define Script_Ogham 70
106 #define Script_Runic 71
107 /* Unicode Chapter 15 */
108 #define Script_Braille 72
109 /* Unicode Chapter 16 */
110 #define Script_Surrogates 73
111 #define Script_Private 74
112 /* Unicode Chapter 13 : Plane 1 */
113 #define Script_Deseret 75
114 #define Script_Osmanya 76
115 #define Script_Osmanya_Numeric 77
116 /* Unicode Chapter 15 : Plane 1 */
117 #define Script_MathAlpha 78
118 /* Additional Currency Scripts */
119 #define Script_Hebrew_Currency 79
120 #define Script_Vietnamese_Currency 80
121 #define Script_Thai_Currency 81
122
123 #define GLYPH_BLOCK_SHIFT 8
124 #define GLYPH_BLOCK_SIZE  (1UL << GLYPH_BLOCK_SHIFT)
125 #define GLYPH_BLOCK_MASK  (GLYPH_BLOCK_SIZE - 1)
126 #define GLYPH_MAX         65536
127
128 #define GSUB_E_NOFEATURE -2
129 #define GSUB_E_NOGLYPH -1
130
131 #define FEATURE_ALL_TABLES 0
132 #define FEATURE_GSUB_TABLE 1
133 #define FEATURE_GPOS_TABLE 2
134
135 typedef struct {
136     OPENTYPE_TAG tag;
137     CHAR tableType;
138     LPCVOID  feature;
139     INT lookup_count;
140     WORD *lookups;
141 } LoadedFeature;
142
143 typedef struct {
144     OPENTYPE_TAG tag;
145     LPCVOID gsub_table;
146     LPCVOID gpos_table;
147     BOOL features_initialized;
148     INT feature_count;
149     LoadedFeature *features;
150 } LoadedLanguage;
151
152 typedef struct {
153     OPENTYPE_TAG tag;
154     LPCVOID gsub_table;
155     LPCVOID gpos_table;
156     LoadedLanguage default_language;
157     BOOL languages_initialized;
158     INT language_count;
159     LoadedLanguage *languages;
160 } LoadedScript;
161
162 typedef struct {
163     WORD *glyphs[GLYPH_MAX / GLYPH_BLOCK_SIZE];
164 } CacheGlyphPage;
165
166 typedef struct {
167     LOGFONTW lf;
168     TEXTMETRICW tm;
169     OUTLINETEXTMETRICW *otm;
170     SCRIPT_FONTPROPERTIES sfp;
171     BOOL sfnt;
172     CacheGlyphPage *page[0x10];
173     ABC *widths[GLYPH_MAX / GLYPH_BLOCK_SIZE];
174     LPVOID GSUB_Table;
175     LPVOID GDEF_Table;
176     LPVOID CMAP_Table;
177     LPVOID CMAP_format12_Table;
178     LPVOID GPOS_Table;
179     BOOL scripts_initialized;
180     INT script_count;
181     LoadedScript *scripts;
182
183     OPENTYPE_TAG userScript;
184     OPENTYPE_TAG userLang;
185 } ScriptCache;
186
187 typedef struct _scriptData
188 {
189     SCRIPT_ANALYSIS a;
190     SCRIPT_PROPERTIES props;
191     OPENTYPE_TAG scriptTag;
192     WCHAR fallbackFont[LF_FACESIZE];
193 } scriptData;
194
195 typedef struct {
196     INT start;
197     INT base;
198     INT ralf;
199     INT blwf;
200     INT pref;
201     INT end;
202 } IndicSyllable;
203
204 enum {lex_Halant, lex_Composed_Vowel, lex_Matra_post, lex_Matra_pre, lex_Matra_above, lex_Matra_below, lex_ZWJ, lex_ZWNJ, lex_NBSP, lex_Modifier, lex_Vowel, lex_Consonant, lex_Generic, lex_Ra, lex_Vedic, lex_Anudatta, lex_Nukta};
205
206 static inline BOOL is_consonant( int type )
207 {
208     return (type == lex_Ra || type == lex_Consonant);
209 }
210
211 static inline WCHAR get_table_entry( const unsigned short *table, WCHAR ch )
212 {
213     return table[table[table[ch >> 8] + ((ch >> 4) & 0x0f)] + (ch & 0xf)];
214 }
215
216 typedef int (*lexical_function)(WCHAR c);
217 typedef void (*reorder_function)(LPWSTR pwChar, IndicSyllable *syllable, lexical_function lex);
218
219 #define odd(x) ((x) & 1)
220 #define BIDI_STRONG  1
221 #define BIDI_WEAK    2
222 #define BIDI_NEUTRAL 0
223
224 int USP10_FindGlyphInLogClust(const WORD* pwLogClust, int cChars, WORD target) DECLSPEC_HIDDEN;
225
226 BOOL BIDI_DetermineLevels( LPCWSTR lpString, INT uCount, const SCRIPT_STATE *s,
227                 const SCRIPT_CONTROL *c, WORD *lpOutLevels ) DECLSPEC_HIDDEN;
228 BOOL BIDI_GetStrengths(LPCWSTR lpString, INT uCount, const SCRIPT_CONTROL *c,
229                       WORD* lpStrength) DECLSPEC_HIDDEN;
230 INT BIDI_ReorderV2lLevel(int level, int *pIndexs, const BYTE* plevel, int cch, BOOL fReverse) DECLSPEC_HIDDEN;
231 INT BIDI_ReorderL2vLevel(int level, int *pIndexs, const BYTE* plevel, int cch, BOOL fReverse) DECLSPEC_HIDDEN;
232 void SHAPE_ContextualShaping(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, WCHAR* pwcChars, INT cChars, WORD* pwOutGlyphs, INT* pcGlyphs, INT cMaxGlyphs, WORD *pwLogClust) DECLSPEC_HIDDEN;
233 void SHAPE_ApplyDefaultOpentypeFeatures(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, WORD* pwOutGlyphs, INT* pcGlyphs, INT cMaxGlyphs, INT cChars, WORD *pwLogClust) DECLSPEC_HIDDEN;
234 void SHAPE_ApplyOpenTypePositions(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, const WORD* pwGlyphs, INT cGlyphs, int *piAdvance, GOFFSET *pGoffset ) DECLSPEC_HIDDEN;
235 HRESULT SHAPE_CheckFontForRequiredFeatures(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa) DECLSPEC_HIDDEN;
236 void SHAPE_CharGlyphProp(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, const WCHAR* pwcChars, const INT cChars, const WORD* pwGlyphs, const INT cGlyphs, WORD *pwLogClust, SCRIPT_CHARPROP *pCharProp, SCRIPT_GLYPHPROP *pGlyphProp) DECLSPEC_HIDDEN;
237 INT SHAPE_does_GSUB_feature_apply_to_chars(HDC hdc, SCRIPT_ANALYSIS *psa, ScriptCache* psc, const WCHAR *chars, INT write_dir, INT count, const char* feature) DECLSPEC_HIDDEN;
238 HRESULT SHAPE_GetFontScriptTags( HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, int cMaxTags, OPENTYPE_TAG *pScriptTags, int *pcTags) DECLSPEC_HIDDEN;
239 HRESULT SHAPE_GetFontLanguageTags( HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, OPENTYPE_TAG tagScript, int cMaxTags, OPENTYPE_TAG *pLangSysTags, int *pcTags) DECLSPEC_HIDDEN;
240 HRESULT SHAPE_GetFontFeatureTags( HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, OPENTYPE_TAG tagScript, OPENTYPE_TAG tagLangSys, int cMaxTags, OPENTYPE_TAG *pFeatureTags, int *pcTags) DECLSPEC_HIDDEN;
241
242 void Indic_ReorderCharacters( HDC hdc, SCRIPT_ANALYSIS *psa, ScriptCache* psc, LPWSTR input, int cChars, IndicSyllable **syllables, int *syllable_count, lexical_function lexical_f, reorder_function reorder_f, BOOL modern) DECLSPEC_HIDDEN;
243 void Indic_ParseSyllables( HDC hdc, SCRIPT_ANALYSIS *psa, ScriptCache* psc, LPCWSTR input, const int cChar, IndicSyllable **syllables, int *syllable_count, lexical_function lex, BOOL modern) DECLSPEC_HIDDEN;
244
245 void BREAK_line(const WCHAR *chars, int count, const SCRIPT_ANALYSIS *sa, SCRIPT_LOGATTR *la) DECLSPEC_HIDDEN;
246
247 DWORD OpenType_CMAP_GetGlyphIndex(HDC hdc, ScriptCache *psc, DWORD utf32c, LPWORD pgi, DWORD flags) DECLSPEC_HIDDEN;
248 void OpenType_GDEF_UpdateGlyphProps(ScriptCache *psc, const WORD *pwGlyphs, const WORD cGlyphs, WORD* pwLogClust, const WORD cChars, SCRIPT_GLYPHPROP *pGlyphProp) DECLSPEC_HIDDEN;
249 INT OpenType_apply_GSUB_lookup(LPCVOID table, INT lookup_index, WORD *glyphs, INT glyph_index, INT write_dir, INT *glyph_count) DECLSPEC_HIDDEN;
250 INT OpenType_apply_GPOS_lookup(ScriptCache *psc, LPOUTLINETEXTMETRICW lpotm, LPLOGFONTW lplogfont, const SCRIPT_ANALYSIS *analysis, INT* piAdvance, INT lookup_index, const WORD *glyphs, INT glyph_index, INT glyph_count, GOFFSET *pGoffset) DECLSPEC_HIDDEN;
251 HRESULT OpenType_GetFontScriptTags(ScriptCache *psc, OPENTYPE_TAG searchingFor, int cMaxTags, OPENTYPE_TAG *pScriptTags, int *pcTags) DECLSPEC_HIDDEN;
252 HRESULT OpenType_GetFontLanguageTags(ScriptCache *psc, OPENTYPE_TAG script_tag, OPENTYPE_TAG searchingFor, int cMaxTags, OPENTYPE_TAG *pLanguageTags, int *pcTags) DECLSPEC_HIDDEN;
253 HRESULT OpenType_GetFontFeatureTags(ScriptCache *psc, OPENTYPE_TAG script_tag, OPENTYPE_TAG language_tag, BOOL filtered, OPENTYPE_TAG searchingFor, char tableType, int cMaxTags, OPENTYPE_TAG *pFeatureTags, int *pcTags, LoadedFeature** feature) DECLSPEC_HIDDEN;