freetype/src/autofit/afblue.h

/* This file has been generated by the Perl script `afblue.pl', */
/* using data from file `afblue.dat'.                           */

/***************************************************************************/
/*                                                                         */
/*  afblue.h                                                               */
/*                                                                         */
/*    Auto-fitter data for blue strings (specification).                   */
/*                                                                         */
/*  Copyright 2013-2016 by                                                 */
/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
/*                                                                         */
/*  This file is part of the FreeType project, and may only be used,       */
/*  modified, and distributed under the terms of the FreeType project      */
/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
/*  this file you indicate that you have read the license and              */
/*  understand and accept it fully.                                        */
/*                                                                         */
/***************************************************************************/


#ifndef AFBLUE_H_
#define AFBLUE_H_


FT_BEGIN_HEADER


  /* an auxiliary macro to decode a UTF-8 character -- since we only use */
  /* hard-coded, self-converted data, no error checking is performed     */
#define GET_UTF8_CHAR( ch, p )                      \
          do                                        \
          {                                         \
            ch = (unsigned char)*p++;               \
            if ( ch >= 0x80 )                       \
            {                                       \
              FT_UInt  len_;                        \
                                                    \
                                                    \
              if ( ch < 0xE0 )                      \
              {                                     \
                len_ = 1;                           \
                ch  &= 0x1F;                        \
              }                                     \
              else if ( ch < 0xF0 )                 \
              {                                     \
                len_ = 2;                           \
                ch  &= 0x0F;                        \
              }                                     \
              else                                  \
              {                                     \
                len_ = 3;                           \
                ch  &= 0x07;                        \
              }                                     \
                                                    \
              for ( ; len_ > 0; len_-- )            \
                ch = ( ch << 6 ) | ( *p++ & 0x3F ); \
            }                                       \
          } while ( 0 )


  /*************************************************************************/
  /*************************************************************************/
  /*****                                                               *****/
  /*****                    B L U E   S T R I N G S                    *****/
  /*****                                                               *****/
  /*************************************************************************/
  /*************************************************************************/

  /* At the bottommost level, we define strings for finding blue zones. */


#define AF_BLUE_STRING_MAX_LEN  51

  /* The AF_Blue_String enumeration values are offsets into the */
  /* `af_blue_strings' array.                                   */

  typedef enum  AF_Blue_String_
  {
    AF_BLUE_STRING_ARABIC_TOP = 0,
    AF_BLUE_STRING_ARABIC_BOTTOM = 18,
    AF_BLUE_STRING_ARABIC_JOIN = 33,
    AF_BLUE_STRING_ARMENIAN_CAPITAL_TOP = 36,
    AF_BLUE_STRING_ARMENIAN_CAPITAL_BOTTOM = 60,
    AF_BLUE_STRING_ARMENIAN_SMALL_ASCENDER = 84,
    AF_BLUE_STRING_ARMENIAN_SMALL_TOP = 108,
    AF_BLUE_STRING_ARMENIAN_SMALL_BOTTOM = 132,
    AF_BLUE_STRING_ARMENIAN_SMALL_DESCENDER = 156,
    AF_BLUE_STRING_BENGALI_BASE = 180,
    AF_BLUE_STRING_BENGALI_TOP = 212,
    AF_BLUE_STRING_BENGALI_HEAD = 240,
    AF_BLUE_STRING_CYRILLIC_CAPITAL_TOP = 272,
    AF_BLUE_STRING_CYRILLIC_CAPITAL_BOTTOM = 296,
    AF_BLUE_STRING_CYRILLIC_SMALL = 320,
    AF_BLUE_STRING_CYRILLIC_SMALL_DESCENDER = 344,
    AF_BLUE_STRING_DEVANAGARI_BASE = 353,
    AF_BLUE_STRING_DEVANAGARI_TOP = 385,
    AF_BLUE_STRING_DEVANAGARI_HEAD = 417,
    AF_BLUE_STRING_DEVANAGARI_BOTTOM = 449,
    AF_BLUE_STRING_GEORGIAN_MKHEDRULI_TOP = 457,
    AF_BLUE_STRING_GEORGIAN_MKHEDRULI_BOTTOM = 489,
    AF_BLUE_STRING_GEORGIAN_MKHEDRULI_ASCENDER = 521,
    AF_BLUE_STRING_GEORGIAN_MKHEDRULI_DESCENDER = 553,
    AF_BLUE_STRING_GEORGIAN_ASOMTAVRULI_TOP = 585,
    AF_BLUE_STRING_GEORGIAN_ASOMTAVRULI_BOTTOM = 617,
    AF_BLUE_STRING_GEORGIAN_NUSKHURI_TOP = 649,
    AF_BLUE_STRING_GEORGIAN_NUSKHURI_BOTTOM = 681,
    AF_BLUE_STRING_GEORGIAN_NUSKHURI_ASCENDER = 713,
    AF_BLUE_STRING_GEORGIAN_NUSKHURI_DESCENDER = 745,
    AF_BLUE_STRING_GREEK_CAPITAL_TOP = 777,
    AF_BLUE_STRING_GREEK_CAPITAL_BOTTOM = 798,
    AF_BLUE_STRING_GREEK_SMALL_BETA_TOP = 816,
    AF_BLUE_STRING_GREEK_SMALL = 834,
    AF_BLUE_STRING_GREEK_SMALL_DESCENDER = 858,
    AF_BLUE_STRING_GUJARATI_TOP = 882,
    AF_BLUE_STRING_GUJARATI_BOTTOM = 914,
    AF_BLUE_STRING_GUJARATI_ASCENDER = 946,
    AF_BLUE_STRING_GUJARATI_DESCENDER = 996,
    AF_BLUE_STRING_GUJARATI_DIGIT_TOP = 1029,
    AF_BLUE_STRING_GURMUKHI_BASE = 1049,
    AF_BLUE_STRING_GURMUKHI_HEAD = 1081,
    AF_BLUE_STRING_GURMUKHI_TOP = 1113,
    AF_BLUE_STRING_GURMUKHI_BOTTOM = 1145,
    AF_BLUE_STRING_GURMUKHI_DIGIT_TOP = 1177,
    AF_BLUE_STRING_HEBREW_TOP = 1197,
    AF_BLUE_STRING_HEBREW_BOTTOM = 1221,
    AF_BLUE_STRING_HEBREW_DESCENDER = 1239,
    AF_BLUE_STRING_KANNADA_TOP = 1254,
    AF_BLUE_STRING_KANNADA_BOTTOM = 1298,
    AF_BLUE_STRING_KHMER_TOP = 1330,
    AF_BLUE_STRING_KHMER_SUBSCRIPT_TOP = 1354,
    AF_BLUE_STRING_KHMER_BOTTOM = 1394,
    AF_BLUE_STRING_KHMER_DESCENDER = 1426,
    AF_BLUE_STRING_KHMER_LARGE_DESCENDER = 1460,
    AF_BLUE_STRING_KHMER_SYMBOLS_WAXING_TOP = 1547,
    AF_BLUE_STRING_KHMER_SYMBOLS_WANING_BOTTOM = 1555,
    AF_BLUE_STRING_LAO_TOP = 1563,
    AF_BLUE_STRING_LAO_BOTTOM = 1595,
    AF_BLUE_STRING_LAO_ASCENDER = 1627,
    AF_BLUE_STRING_LAO_LARGE_ASCENDER = 1643,
    AF_BLUE_STRING_LAO_DESCENDER = 1655,
    AF_BLUE_STRING_LATIN_CAPITAL_TOP = 1679,
    AF_BLUE_STRING_LATIN_CAPITAL_BOTTOM = 1695,
    AF_BLUE_STRING_LATIN_SMALL_F_TOP = 1711,
    AF_BLUE_STRING_LATIN_SMALL = 1725,
    AF_BLUE_STRING_LATIN_SMALL_DESCENDER = 1739,
    AF_BLUE_STRING_LATIN_SUBS_CAPITAL_TOP = 1749,
    AF_BLUE_STRING_LATIN_SUBS_CAPITAL_BOTTOM = 1769,
    AF_BLUE_STRING_LATIN_SUBS_SMALL_F_TOP = 1789,
    AF_BLUE_STRING_LATIN_SUBS_SMALL = 1809,
    AF_BLUE_STRING_LATIN_SUBS_SMALL_DESCENDER = 1845,
    AF_BLUE_STRING_LATIN_SUPS_CAPITAL_TOP = 1865,
    AF_BLUE_STRING_LATIN_SUPS_CAPITAL_BOTTOM = 1896,
    AF_BLUE_STRING_LATIN_SUPS_SMALL_F_TOP = 1925,
    AF_BLUE_STRING_LATIN_SUPS_SMALL = 1951,
    AF_BLUE_STRING_LATIN_SUPS_SMALL_DESCENDER = 1976,
    AF_BLUE_STRING_MALAYALAM_TOP = 1987,
    AF_BLUE_STRING_MALAYALAM_BOTTOM = 2031,
    AF_BLUE_STRING_MYANMAR_TOP = 2063,
    AF_BLUE_STRING_MYANMAR_BOTTOM = 2095,
    AF_BLUE_STRING_MYANMAR_ASCENDER = 2127,
    AF_BLUE_STRING_MYANMAR_DESCENDER = 2155,
    AF_BLUE_STRING_SINHALA_TOP = 2187,
    AF_BLUE_STRING_SINHALA_BOTTOM = 2219,
    AF_BLUE_STRING_SINHALA_DESCENDER = 2251,
    AF_BLUE_STRING_TAMIL_TOP = 2295,
    AF_BLUE_STRING_TAMIL_BOTTOM = 2327,
    AF_BLUE_STRING_TELUGU_TOP = 2359,
    AF_BLUE_STRING_TELUGU_BOTTOM = 2387,
    AF_BLUE_STRING_THAI_TOP = 2415,
    AF_BLUE_STRING_THAI_BOTTOM = 2439,
    AF_BLUE_STRING_THAI_ASCENDER = 2467,
    AF_BLUE_STRING_THAI_LARGE_ASCENDER = 2479,
    AF_BLUE_STRING_THAI_DESCENDER = 2491,
    AF_BLUE_STRING_THAI_LARGE_DESCENDER = 2507,
    AF_BLUE_STRING_THAI_DIGIT_TOP = 2515,
    af_blue_1_1 = 2526,
#ifdef AF_CONFIG_OPTION_CJK
    AF_BLUE_STRING_CJK_TOP = af_blue_1_1 + 1,
    AF_BLUE_STRING_CJK_BOTTOM = af_blue_1_1 + 203,
    af_blue_1_1_1 = af_blue_1_1 + 404,
#ifdef AF_CONFIG_OPTION_CJK_BLUE_HANI_VERT
    AF_BLUE_STRING_CJK_LEFT = af_blue_1_1_1 + 1,
    AF_BLUE_STRING_CJK_RIGHT = af_blue_1_1_1 + 204,
    af_blue_1_1_2 = af_blue_1_1_1 + 405,
#else
    af_blue_1_1_2 = af_blue_1_1_1 + 0,
#endif /* AF_CONFIG_OPTION_CJK_BLUE_HANI_VERT */
    af_blue_1_2 = af_blue_1_1_2 + 0,
#else
    af_blue_1_2 = af_blue_1_1 + 0,
#endif /* AF_CONFIG_OPTION_CJK                */


    AF_BLUE_STRING_MAX   /* do not remove */

  } AF_Blue_String;


  FT_LOCAL_ARRAY( char )
  af_blue_strings[];


  /*************************************************************************/
  /*************************************************************************/
  /*****                                                               *****/
  /*****                 B L U E   S T R I N G S E T S                 *****/
  /*****                                                               *****/
  /*************************************************************************/
  /*************************************************************************/

  /* The next level is to group blue strings into style-specific sets. */


  /* Properties are specific to a writing system.  We assume that a given  */
  /* blue string can't be used in more than a single writing system, which */
  /* is a safe bet.                                                        */
#define AF_BLUE_PROPERTY_LATIN_TOP       ( 1U << 0 )  /* must have value 1 */
#define AF_BLUE_PROPERTY_LATIN_SUB_TOP   ( 1U << 1 )
#define AF_BLUE_PROPERTY_LATIN_NEUTRAL   ( 1U << 2 )
#define AF_BLUE_PROPERTY_LATIN_X_HEIGHT  ( 1U << 3 )
#define AF_BLUE_PROPERTY_LATIN_LONG      ( 1U << 4 )

#define AF_BLUE_PROPERTY_CJK_TOP    ( 1U << 0 )       /* must have value 1 */
#define AF_BLUE_PROPERTY_CJK_HORIZ  ( 1U << 1 )       /* must have value 2 */
#define AF_BLUE_PROPERTY_CJK_RIGHT  AF_BLUE_PROPERTY_CJK_TOP


#define AF_BLUE_STRINGSET_MAX_LEN  8

  /* The AF_Blue_Stringset enumeration values are offsets into the */
  /* `af_blue_stringsets' array.                                   */

  typedef enum  AF_Blue_Stringset_
  {
    AF_BLUE_STRINGSET_ARAB = 0,
    AF_BLUE_STRINGSET_BENG = 4,
    AF_BLUE_STRINGSET_ARMN = 9,
    AF_BLUE_STRINGSET_CYRL = 16,
    AF_BLUE_STRINGSET_DEVA = 22,
    AF_BLUE_STRINGSET_GEOR = 28,
    AF_BLUE_STRINGSET_GEOK = 33,
    AF_BLUE_STRINGSET_GREK = 40,
    AF_BLUE_STRINGSET_GUJR = 47,
    AF_BLUE_STRINGSET_GURU = 53,
    AF_BLUE_STRINGSET_HEBR = 59,
    AF_BLUE_STRINGSET_KNDA = 63,
    AF_BLUE_STRINGSET_KHMR = 66,
    AF_BLUE_STRINGSET_KHMS = 72,
    AF_BLUE_STRINGSET_LAO = 75,
    AF_BLUE_STRINGSET_LATN = 81,
    AF_BLUE_STRINGSET_LATB = 88,
    AF_BLUE_STRINGSET_LATP = 95,
    AF_BLUE_STRINGSET_MLYM = 102,
    AF_BLUE_STRINGSET_MYMR = 105,
    AF_BLUE_STRINGSET_NONE = 110,
    AF_BLUE_STRINGSET_SINH = 111,
    AF_BLUE_STRINGSET_TAML = 115,
    AF_BLUE_STRINGSET_TELU = 118,
    AF_BLUE_STRINGSET_THAI = 121,
    af_blue_2_1 = 129,
#ifdef AF_CONFIG_OPTION_CJK
    AF_BLUE_STRINGSET_HANI = af_blue_2_1 + 0,
    af_blue_2_1_1 = af_blue_2_1 + 2,
#ifdef AF_CONFIG_OPTION_CJK_BLUE_HANI_VERT
    af_blue_2_1_2 = af_blue_2_1_1 + 2,
#else
    af_blue_2_1_2 = af_blue_2_1_1 + 0,
#endif /* AF_CONFIG_OPTION_CJK_BLUE_HANI_VERT */
    af_blue_2_2 = af_blue_2_1_2 + 1,
#else
    af_blue_2_2 = af_blue_2_1 + 0,
#endif /* AF_CONFIG_OPTION_CJK                */


    AF_BLUE_STRINGSET_MAX   /* do not remove */

  } AF_Blue_Stringset;


  typedef struct  AF_Blue_StringRec_
  {
    AF_Blue_String  string;
    FT_UShort       properties;

  } AF_Blue_StringRec;


  FT_LOCAL_ARRAY( AF_Blue_StringRec )
  af_blue_stringsets[];

/* */

FT_END_HEADER


#endif /* AFBLUE_H_ */


/* END */