[USP10] Sync with Wine Staging 2.9. CORE-13362
[reactos.git] / reactos / 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 #ifndef ARRAY_SIZE
48 #define ARRAY_SIZE(array) (sizeof(array) / sizeof((array)[0]))
49 #endif
50
51 enum usp10_script
52 {
53 Script_Undefined = 0x00,
54 Script_Latin = 0x01,
55 Script_CR = 0x02,
56 Script_Numeric = 0x03,
57 Script_Control = 0x04,
58 Script_Punctuation = 0x05,
59 Script_Arabic = 0x06,
60 Script_Arabic_Numeric = 0x07,
61 Script_Hebrew = 0x08,
62 Script_Syriac = 0x09,
63 Script_Persian = 0x0a,
64 Script_Thaana = 0x0b,
65 Script_Greek = 0x0c,
66 Script_Cyrillic = 0x0d,
67 Script_Armenian = 0x0e,
68 Script_Georgian = 0x0f,
69 /* Unicode Chapter 10 */
70 Script_Sinhala = 0x10,
71 Script_Tibetan = 0x11,
72 Script_Tibetan_Numeric = 0x12,
73 Script_Phags_pa = 0x13,
74 /* Unicode Chapter 11 */
75 Script_Thai = 0x14,
76 Script_Thai_Numeric = 0x15,
77 Script_Lao = 0x16,
78 Script_Lao_Numeric = 0x17,
79 /* Unicode Chapter 9 */
80 Script_Devanagari = 0x18,
81 Script_Devanagari_Numeric = 0x19,
82 Script_Bengali = 0x1a,
83 Script_Bengali_Numeric = 0x1b,
84 Script_Bengali_Currency = 0x1c,
85 Script_Gurmukhi = 0x1d,
86 Script_Gurmukhi_Numeric = 0x1e,
87 Script_Gujarati = 0x1f,
88 Script_Gujarati_Numeric = 0x20,
89 Script_Gujarati_Currency = 0x21,
90 Script_Oriya = 0x22,
91 Script_Oriya_Numeric = 0x23,
92 Script_Tamil = 0x24,
93 Script_Tamil_Numeric = 0x25,
94 Script_Telugu = 0x26,
95 Script_Telugu_Numeric = 0x27,
96 Script_Kannada = 0x28,
97 Script_Kannada_Numeric = 0x29,
98 Script_Malayalam = 0x2a,
99 Script_Malayalam_Numeric = 0x2b,
100 /* More supplemental */
101 Script_Diacritical = 0x2c,
102 Script_Punctuation2 = 0x2d,
103 Script_Numeric2 = 0x2e,
104 /* Unicode Chapter 11 continued */
105 Script_Myanmar = 0x2f,
106 Script_Myanmar_Numeric = 0x30,
107 Script_Tai_Le = 0x31,
108 Script_New_Tai_Lue = 0x32,
109 Script_New_Tai_Lue_Numeric = 0x33,
110 Script_Khmer = 0x34,
111 Script_Khmer_Numeric = 0x35,
112 /* Unicode Chapter 12 */
113 Script_CJK_Han = 0x36,
114 Script_Ideograph = 0x37,
115 Script_Bopomofo = 0x38,
116 Script_Kana = 0x39,
117 Script_Hangul = 0x3a,
118 Script_Yi = 0x3b,
119 /* Unicode Chapter 13 */
120 Script_Ethiopic = 0x3c,
121 Script_Ethiopic_Numeric = 0x3d,
122 Script_Mongolian = 0x3e,
123 Script_Mongolian_Numeric = 0x3f,
124 Script_Tifinagh = 0x40,
125 Script_NKo = 0x41,
126 Script_Vai = 0x42,
127 Script_Vai_Numeric = 0x43,
128 Script_Cherokee = 0x44,
129 Script_Canadian = 0x45,
130 /* Unicode Chapter 14 */
131 Script_Ogham = 0x46,
132 Script_Runic = 0x47,
133 /* Unicode Chapter 15 */
134 Script_Braille = 0x48,
135 /* Unicode Chapter 16 */
136 Script_Surrogates = 0x49,
137 Script_Private = 0x4a,
138 /* Unicode Chapter 13 : Plane 1 */
139 Script_Deseret = 0x4b,
140 Script_Osmanya = 0x4c,
141 Script_Osmanya_Numeric = 0x4d,
142 /* Unicode Chapter 15 : Plane 1 */
143 Script_MathAlpha = 0x4e,
144 /* Additional Currency Scripts */
145 Script_Hebrew_Currency = 0x4f,
146 Script_Vietnamese_Currency = 0x50,
147 Script_Thai_Currency = 0x51,
148 };
149
150 #define GLYPH_BLOCK_SHIFT 8
151 #define GLYPH_BLOCK_SIZE (1UL << GLYPH_BLOCK_SHIFT)
152 #define GLYPH_BLOCK_MASK (GLYPH_BLOCK_SIZE - 1)
153 #define GLYPH_MAX 65536
154
155 #define NUM_PAGES 17
156
157 #define GSUB_E_NOFEATURE -20
158 #define GSUB_E_NOGLYPH -10
159
160 #define FEATURE_ALL_TABLES 0
161 #define FEATURE_GSUB_TABLE 1
162 #define FEATURE_GPOS_TABLE 2
163
164 typedef struct {
165 OPENTYPE_TAG tag;
166 CHAR tableType;
167 const void *feature;
168 INT lookup_count;
169 WORD *lookups;
170 } LoadedFeature;
171
172 typedef struct {
173 OPENTYPE_TAG tag;
174 const void *gsub_table;
175 const void *gpos_table;
176 BOOL features_initialized;
177 INT feature_count;
178 LoadedFeature *features;
179 } LoadedLanguage;
180
181 typedef struct {
182 OPENTYPE_TAG tag;
183 const void *gsub_table;
184 const void *gpos_table;
185 LoadedLanguage default_language;
186 BOOL languages_initialized;
187 LoadedLanguage *languages;
188 SIZE_T languages_size;
189 SIZE_T language_count;
190 } LoadedScript;
191
192 typedef struct {
193 WORD *glyphs[GLYPH_MAX / GLYPH_BLOCK_SIZE];
194 } CacheGlyphPage;
195
196 typedef struct {
197 LOGFONTW lf;
198 TEXTMETRICW tm;
199 OUTLINETEXTMETRICW *otm;
200 SCRIPT_FONTPROPERTIES sfp;
201 BOOL sfnt;
202 CacheGlyphPage *page[NUM_PAGES];
203 ABC *widths[GLYPH_MAX / GLYPH_BLOCK_SIZE];
204 void *GSUB_Table;
205 void *GDEF_Table;
206 void *CMAP_Table;
207 void *CMAP_format12_Table;
208 void *GPOS_Table;
209 BOOL scripts_initialized;
210 LoadedScript *scripts;
211 SIZE_T scripts_size;
212 SIZE_T script_count;
213
214 OPENTYPE_TAG userScript;
215 OPENTYPE_TAG userLang;
216 } ScriptCache;
217
218 typedef struct _scriptData
219 {
220 SCRIPT_ANALYSIS a;
221 SCRIPT_PROPERTIES props;
222 OPENTYPE_TAG scriptTag;
223 WCHAR fallbackFont[LF_FACESIZE];
224 } scriptData;
225
226 typedef struct {
227 INT start;
228 INT base;
229 INT ralf;
230 INT blwf;
231 INT pref;
232 INT end;
233 } IndicSyllable;
234
235 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};
236
237 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc(size_t size)
238 {
239 return HeapAlloc(GetProcessHeap(), 0, size);
240 }
241
242 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc_zero(size_t size)
243 {
244 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
245 }
246
247 static inline BOOL heap_free(void *mem)
248 {
249 return HeapFree(GetProcessHeap(), 0, mem);
250 }
251
252 static inline BOOL is_consonant( int type )
253 {
254 return (type == lex_Ra || type == lex_Consonant);
255 }
256
257 static inline unsigned short get_table_entry( const unsigned short *table, WCHAR ch )
258 {
259 return table[table[table[ch >> 8] + ((ch >> 4) & 0x0f)] + (ch & 0xf)];
260 }
261
262 typedef int (*lexical_function)(WCHAR c);
263 typedef void (*reorder_function)(WCHAR *chars, IndicSyllable *syllable, lexical_function lex);
264
265 #define odd(x) ((x) & 1)
266 #define BIDI_STRONG 1
267 #define BIDI_WEAK 2
268 #define BIDI_NEUTRAL 0
269
270 BOOL usp10_array_reserve(void **elements, SIZE_T *capacity, SIZE_T count, SIZE_T size) DECLSPEC_HIDDEN;
271 int USP10_FindGlyphInLogClust(const WORD* pwLogClust, int cChars, WORD target) DECLSPEC_HIDDEN;
272
273 BOOL BIDI_DetermineLevels(const WCHAR *string, unsigned int count, const SCRIPT_STATE *s,
274 const SCRIPT_CONTROL *c, WORD *levels, WORD *overrides) DECLSPEC_HIDDEN;
275 BOOL BIDI_GetStrengths(const WCHAR *string, unsigned int count,
276 const SCRIPT_CONTROL *c, WORD *strength) DECLSPEC_HIDDEN;
277 INT BIDI_ReorderV2lLevel(int level, int *pIndexs, const BYTE* plevel, int cch, BOOL fReverse) DECLSPEC_HIDDEN;
278 INT BIDI_ReorderL2vLevel(int level, int *pIndexs, const BYTE* plevel, int cch, BOOL fReverse) DECLSPEC_HIDDEN;
279 void SHAPE_ContextualShaping(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, WCHAR* pwcChars, INT cChars, WORD* pwOutGlyphs, INT* pcGlyphs, INT cMaxGlyphs, WORD *pwLogClust) DECLSPEC_HIDDEN;
280 void SHAPE_ApplyDefaultOpentypeFeatures(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, WORD* pwOutGlyphs, INT* pcGlyphs, INT cMaxGlyphs, INT cChars, WORD *pwLogClust) DECLSPEC_HIDDEN;
281 void SHAPE_ApplyOpenTypePositions(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, const WORD* pwGlyphs, INT cGlyphs, int *piAdvance, GOFFSET *pGoffset ) DECLSPEC_HIDDEN;
282 HRESULT SHAPE_CheckFontForRequiredFeatures(HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa) DECLSPEC_HIDDEN;
283 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;
284 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;
285 HRESULT SHAPE_GetFontScriptTags( HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, int cMaxTags, OPENTYPE_TAG *pScriptTags, int *pcTags) DECLSPEC_HIDDEN;
286 HRESULT SHAPE_GetFontLanguageTags( HDC hdc, ScriptCache *psc, SCRIPT_ANALYSIS *psa, OPENTYPE_TAG tagScript, int cMaxTags, OPENTYPE_TAG *pLangSysTags, int *pcTags) DECLSPEC_HIDDEN;
287 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;
288
289 void Indic_ReorderCharacters(HDC hdc, SCRIPT_ANALYSIS *psa, ScriptCache *psc, WCHAR *input, unsigned int cChars,
290 IndicSyllable **syllables, int *syllable_count, lexical_function lexical_f,
291 reorder_function reorder_f, BOOL modern) DECLSPEC_HIDDEN;
292 void Indic_ParseSyllables(HDC hdc, SCRIPT_ANALYSIS *psa, ScriptCache* psc, const WCHAR *input, unsigned int cChar,
293 IndicSyllable **syllables, int *syllable_count, lexical_function lex, BOOL modern) DECLSPEC_HIDDEN;
294
295 void BREAK_line(const WCHAR *chars, int count, const SCRIPT_ANALYSIS *sa, SCRIPT_LOGATTR *la) DECLSPEC_HIDDEN;
296
297 DWORD OpenType_CMAP_GetGlyphIndex(HDC hdc, ScriptCache *psc, DWORD utf32c, LPWORD pgi, DWORD flags) DECLSPEC_HIDDEN;
298 void OpenType_GDEF_UpdateGlyphProps(ScriptCache *psc, const WORD *pwGlyphs, const WORD cGlyphs, WORD* pwLogClust, const WORD cChars, SCRIPT_GLYPHPROP *pGlyphProp) DECLSPEC_HIDDEN;
299 int OpenType_apply_GSUB_lookup(const void *table, unsigned int lookup_index, WORD *glyphs,
300 unsigned int glyph_index, int write_dir, int *glyph_count) DECLSPEC_HIDDEN;
301 unsigned int OpenType_apply_GPOS_lookup(const ScriptCache *psc, const OUTLINETEXTMETRICW *otm,
302 const LOGFONTW *logfont, const SCRIPT_ANALYSIS *analysis, int *advance, unsigned int lookup_index,
303 const WORD *glyphs, unsigned int glyph_index, unsigned int glyph_count, GOFFSET *goffset) DECLSPEC_HIDDEN;
304 HRESULT OpenType_GetFontScriptTags(ScriptCache *psc, OPENTYPE_TAG searchingFor, int cMaxTags, OPENTYPE_TAG *pScriptTags, int *pcTags) DECLSPEC_HIDDEN;
305 HRESULT OpenType_GetFontLanguageTags(ScriptCache *psc, OPENTYPE_TAG script_tag, OPENTYPE_TAG searchingFor, int cMaxTags, OPENTYPE_TAG *pLanguageTags, int *pcTags) DECLSPEC_HIDDEN;
306 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;
307
308 #endif /* _USP10_INTERNAL_H_ */