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