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