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