gfx/harfbuzz/src/hb-aat-layout.cc

   1 /*
   2  * Copyright © 2017  Google, Inc.
   3  * Copyright © 2018  Ebrahim Byagowi
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Google Author(s): Behdad Esfahbod
  26  */
  27
  28 #include "hb.hh"
  29
  30 #include "hb-aat-layout.hh"
  31 #include "hb-aat-layout-ankr-table.hh"
  32 #include "hb-aat-layout-bsln-table.hh" // Just so we compile it; unused otherwise.
  33 #include "hb-aat-layout-feat-table.hh"
  34 #include "hb-aat-layout-just-table.hh" // Just so we compile it; unused otherwise.
  35 #include "hb-aat-layout-kerx-table.hh"
  36 #include "hb-aat-layout-morx-table.hh"
  37 #include "hb-aat-layout-trak-table.hh"
  38 #include "hb-aat-ltag-table.hh"
  39
  40
  41 /*
  42  * hb_aat_apply_context_t
  43  */
  44
  45 /* Note: This context is used for kerning, even without AAT, hence the condition. */
  46 #if !defined(HB_NO_AAT) || !defined(HB_NO_OT_KERN)
  47
  48 AAT::hb_aat_apply_context_t::hb_aat_apply_context_t (const hb_ot_shape_plan_t *plan_,
  49                                                      hb_font_t *font_,
  50                                                      hb_buffer_t *buffer_,
  51                                                      hb_blob_t *blob) :
  52                                                        plan (plan_),
  53                                                        font (font_),
  54                                                        face (font->face),
  55                                                        buffer (buffer_),
  56                                                        sanitizer (),
  57                                                        ankr_table (&Null (AAT::ankr)),
  58                                                        gdef_table (
  59 #ifndef HB_NO_OT_LAYOUT
  60                                                          face->table.GDEF->table
  61 #else
  62                                                          &Null (GDEF)
  63 #endif
  64                                                        ),
  65                                                        lookup_index (0)
  66 {
  67   sanitizer.init (blob);
  68   sanitizer.set_num_glyphs (face->get_num_glyphs ());
  69   sanitizer.start_processing ();
  70   sanitizer.set_max_ops (HB_SANITIZE_MAX_OPS_MAX);
  71 }
  72
  73 AAT::hb_aat_apply_context_t::~hb_aat_apply_context_t ()
  74 { sanitizer.end_processing (); }
  75
  76 void
  77 AAT::hb_aat_apply_context_t::set_ankr_table (const AAT::ankr *ankr_table_)
  78 { ankr_table = ankr_table_; }
  79
  80 #endif
  81
  82
  83 /**
  84  * SECTION:hb-aat-layout
  85  * @title: hb-aat-layout
  86  * @short_description: Apple Advanced Typography Layout
  87  * @include: hb-aat.h
  88  *
  89  * Functions for querying AAT Layout features in the font face.
  90  *
  91  * HarfBuzz supports all of the AAT tables used to implement shaping. Other
  92  * AAT tables and their associated features are not supported.
  93  **/
  94
  95
  96 #if !defined(HB_NO_AAT) || defined(HAVE_CORETEXT)
  97
  98 /* Mapping from OpenType feature tags to AAT feature names and selectors.
  99  *
 100  * Table data courtesy of Apple.  Converted from mnemonics to integers
 101  * when moving to this file. */
 102 static const hb_aat_feature_mapping_t feature_mappings[] =
 103 {
 104   {HB_TAG ('a','f','r','c'), HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS,               HB_AAT_LAYOUT_FEATURE_SELECTOR_VERTICAL_FRACTIONS,             HB_AAT_LAYOUT_FEATURE_SELECTOR_NO_FRACTIONS},
 105   {HB_TAG ('c','2','p','c'), HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE,              HB_AAT_LAYOUT_FEATURE_SELECTOR_UPPER_CASE_PETITE_CAPS,         HB_AAT_LAYOUT_FEATURE_SELECTOR_DEFAULT_UPPER_CASE},
 106   {HB_TAG ('c','2','s','c'), HB_AAT_LAYOUT_FEATURE_TYPE_UPPER_CASE,              HB_AAT_LAYOUT_FEATURE_SELECTOR_UPPER_CASE_SMALL_CAPS,          HB_AAT_LAYOUT_FEATURE_SELECTOR_DEFAULT_UPPER_CASE},
 107   {HB_TAG ('c','a','l','t'), HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES, HB_AAT_LAYOUT_FEATURE_SELECTOR_CONTEXTUAL_ALTERNATES_ON,       HB_AAT_LAYOUT_FEATURE_SELECTOR_CONTEXTUAL_ALTERNATES_OFF},
 108   {HB_TAG ('c','a','s','e'), HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT,   HB_AAT_LAYOUT_FEATURE_SELECTOR_CASE_SENSITIVE_LAYOUT_ON,       HB_AAT_LAYOUT_FEATURE_SELECTOR_CASE_SENSITIVE_LAYOUT_OFF},
 109   {HB_TAG ('c','l','i','g'), HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES,               HB_AAT_LAYOUT_FEATURE_SELECTOR_CONTEXTUAL_LIGATURES_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_CONTEXTUAL_LIGATURES_OFF},
 110   {HB_TAG ('c','p','s','p'), HB_AAT_LAYOUT_FEATURE_TYPE_CASE_SENSITIVE_LAYOUT,   HB_AAT_LAYOUT_FEATURE_SELECTOR_CASE_SENSITIVE_SPACING_ON,      HB_AAT_LAYOUT_FEATURE_SELECTOR_CASE_SENSITIVE_SPACING_OFF},
 111   {HB_TAG ('c','s','w','h'), HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES, HB_AAT_LAYOUT_FEATURE_SELECTOR_CONTEXTUAL_SWASH_ALTERNATES_ON, HB_AAT_LAYOUT_FEATURE_SELECTOR_CONTEXTUAL_SWASH_ALTERNATES_OFF},
 112   {HB_TAG ('d','l','i','g'), HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES,               HB_AAT_LAYOUT_FEATURE_SELECTOR_RARE_LIGATURES_ON,              HB_AAT_LAYOUT_FEATURE_SELECTOR_RARE_LIGATURES_OFF},
 113   {HB_TAG ('e','x','p','t'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_EXPERT_CHARACTERS,              (hb_aat_layout_feature_selector_t) 16},
 114   {HB_TAG ('f','r','a','c'), HB_AAT_LAYOUT_FEATURE_TYPE_FRACTIONS,               HB_AAT_LAYOUT_FEATURE_SELECTOR_DIAGONAL_FRACTIONS,             HB_AAT_LAYOUT_FEATURE_SELECTOR_NO_FRACTIONS},
 115   {HB_TAG ('f','w','i','d'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_MONOSPACED_TEXT,                (hb_aat_layout_feature_selector_t) 7},
 116   {HB_TAG ('h','a','l','t'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_ALT_HALF_WIDTH_TEXT,            (hb_aat_layout_feature_selector_t) 7},
 117   {HB_TAG ('h','i','s','t'), (hb_aat_layout_feature_type_t) 40,                  (hb_aat_layout_feature_selector_t) 0,                          (hb_aat_layout_feature_selector_t) 1},
 118   {HB_TAG ('h','k','n','a'), HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA,          HB_AAT_LAYOUT_FEATURE_SELECTOR_ALTERNATE_HORIZ_KANA_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_ALTERNATE_HORIZ_KANA_OFF},
 119   {HB_TAG ('h','l','i','g'), HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES,               HB_AAT_LAYOUT_FEATURE_SELECTOR_HISTORICAL_LIGATURES_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_HISTORICAL_LIGATURES_OFF},
 120   {HB_TAG ('h','n','g','l'), HB_AAT_LAYOUT_FEATURE_TYPE_TRANSLITERATION,         HB_AAT_LAYOUT_FEATURE_SELECTOR_HANJA_TO_HANGUL,                HB_AAT_LAYOUT_FEATURE_SELECTOR_NO_TRANSLITERATION},
 121   {HB_TAG ('h','o','j','o'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_HOJO_CHARACTERS,                (hb_aat_layout_feature_selector_t) 16},
 122   {HB_TAG ('h','w','i','d'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_HALF_WIDTH_TEXT,                (hb_aat_layout_feature_selector_t) 7},
 123   {HB_TAG ('i','t','a','l'), HB_AAT_LAYOUT_FEATURE_TYPE_ITALIC_CJK_ROMAN,        HB_AAT_LAYOUT_FEATURE_SELECTOR_CJK_ITALIC_ROMAN_ON,            HB_AAT_LAYOUT_FEATURE_SELECTOR_CJK_ITALIC_ROMAN_OFF},
 124   {HB_TAG ('j','p','0','4'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_JIS2004_CHARACTERS,             (hb_aat_layout_feature_selector_t) 16},
 125   {HB_TAG ('j','p','7','8'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_JIS1978_CHARACTERS,             (hb_aat_layout_feature_selector_t) 16},
 126   {HB_TAG ('j','p','8','3'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_JIS1983_CHARACTERS,             (hb_aat_layout_feature_selector_t) 16},
 127   {HB_TAG ('j','p','9','0'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_JIS1990_CHARACTERS,             (hb_aat_layout_feature_selector_t) 16},
 128   {HB_TAG ('l','i','g','a'), HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES,               HB_AAT_LAYOUT_FEATURE_SELECTOR_COMMON_LIGATURES_ON,            HB_AAT_LAYOUT_FEATURE_SELECTOR_COMMON_LIGATURES_OFF},
 129   {HB_TAG ('l','n','u','m'), HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_CASE,             HB_AAT_LAYOUT_FEATURE_SELECTOR_UPPER_CASE_NUMBERS,             (hb_aat_layout_feature_selector_t) 2},
 130   {HB_TAG ('m','g','r','k'), HB_AAT_LAYOUT_FEATURE_TYPE_MATHEMATICAL_EXTRAS,     HB_AAT_LAYOUT_FEATURE_SELECTOR_MATHEMATICAL_GREEK_ON,          HB_AAT_LAYOUT_FEATURE_SELECTOR_MATHEMATICAL_GREEK_OFF},
 131   {HB_TAG ('n','l','c','k'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_NLCCHARACTERS,                  (hb_aat_layout_feature_selector_t) 16},
 132   {HB_TAG ('o','n','u','m'), HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_CASE,             HB_AAT_LAYOUT_FEATURE_SELECTOR_LOWER_CASE_NUMBERS,             (hb_aat_layout_feature_selector_t) 2},
 133   {HB_TAG ('o','r','d','n'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION,       HB_AAT_LAYOUT_FEATURE_SELECTOR_ORDINALS,                       HB_AAT_LAYOUT_FEATURE_SELECTOR_NORMAL_POSITION},
 134   {HB_TAG ('p','a','l','t'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_ALT_PROPORTIONAL_TEXT,          (hb_aat_layout_feature_selector_t) 7},
 135   {HB_TAG ('p','c','a','p'), HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE,              HB_AAT_LAYOUT_FEATURE_SELECTOR_LOWER_CASE_PETITE_CAPS,         HB_AAT_LAYOUT_FEATURE_SELECTOR_DEFAULT_LOWER_CASE},
 136   {HB_TAG ('p','k','n','a'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_PROPORTIONAL_TEXT,              (hb_aat_layout_feature_selector_t) 7},
 137   {HB_TAG ('p','n','u','m'), HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING,          HB_AAT_LAYOUT_FEATURE_SELECTOR_PROPORTIONAL_NUMBERS,           (hb_aat_layout_feature_selector_t) 4},
 138   {HB_TAG ('p','w','i','d'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_PROPORTIONAL_TEXT,              (hb_aat_layout_feature_selector_t) 7},
 139   {HB_TAG ('q','w','i','d'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_QUARTER_WIDTH_TEXT,             (hb_aat_layout_feature_selector_t) 7},
 140   {HB_TAG ('r','l','i','g'), HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES,               HB_AAT_LAYOUT_FEATURE_SELECTOR_REQUIRED_LIGATURES_ON,          HB_AAT_LAYOUT_FEATURE_SELECTOR_REQUIRED_LIGATURES_OFF},
 141   {HB_TAG ('r','u','b','y'), HB_AAT_LAYOUT_FEATURE_TYPE_RUBY_KANA,               HB_AAT_LAYOUT_FEATURE_SELECTOR_RUBY_KANA_ON,                   HB_AAT_LAYOUT_FEATURE_SELECTOR_RUBY_KANA_OFF},
 142   {HB_TAG ('s','i','n','f'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION,       HB_AAT_LAYOUT_FEATURE_SELECTOR_SCIENTIFIC_INFERIORS,           HB_AAT_LAYOUT_FEATURE_SELECTOR_NORMAL_POSITION},
 143   {HB_TAG ('s','m','c','p'), HB_AAT_LAYOUT_FEATURE_TYPE_LOWER_CASE,              HB_AAT_LAYOUT_FEATURE_SELECTOR_LOWER_CASE_SMALL_CAPS,          HB_AAT_LAYOUT_FEATURE_SELECTOR_DEFAULT_LOWER_CASE},
 144   {HB_TAG ('s','m','p','l'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_SIMPLIFIED_CHARACTERS,          (hb_aat_layout_feature_selector_t) 16},
 145   {HB_TAG ('s','s','0','1'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_ONE_ON,           HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_ONE_OFF},
 146   {HB_TAG ('s','s','0','2'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TWO_ON,           HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TWO_OFF},
 147   {HB_TAG ('s','s','0','3'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_THREE_ON,         HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_THREE_OFF},
 148   {HB_TAG ('s','s','0','4'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FOUR_ON,          HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FOUR_OFF},
 149   {HB_TAG ('s','s','0','5'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FIVE_ON,          HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FIVE_OFF},
 150   {HB_TAG ('s','s','0','6'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SIX_ON,           HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SIX_OFF},
 151   {HB_TAG ('s','s','0','7'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SEVEN_ON,         HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SEVEN_OFF},
 152   {HB_TAG ('s','s','0','8'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_EIGHT_ON,         HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_EIGHT_OFF},
 153   {HB_TAG ('s','s','0','9'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_NINE_ON,          HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_NINE_OFF},
 154   {HB_TAG ('s','s','1','0'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TEN_ON,           HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TEN_OFF},
 155   {HB_TAG ('s','s','1','1'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_ELEVEN_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_ELEVEN_OFF},
 156   {HB_TAG ('s','s','1','2'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TWELVE_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TWELVE_OFF},
 157   {HB_TAG ('s','s','1','3'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_THIRTEEN_ON,      HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_THIRTEEN_OFF},
 158   {HB_TAG ('s','s','1','4'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FOURTEEN_ON,      HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FOURTEEN_OFF},
 159   {HB_TAG ('s','s','1','5'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FIFTEEN_ON,       HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_FIFTEEN_OFF},
 160   {HB_TAG ('s','s','1','6'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SIXTEEN_ON,       HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SIXTEEN_OFF},
 161   {HB_TAG ('s','s','1','7'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SEVENTEEN_ON,     HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_SEVENTEEN_OFF},
 162   {HB_TAG ('s','s','1','8'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_EIGHTEEN_ON,      HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_EIGHTEEN_OFF},
 163   {HB_TAG ('s','s','1','9'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_NINETEEN_ON,      HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_NINETEEN_OFF},
 164   {HB_TAG ('s','s','2','0'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLISTIC_ALTERNATIVES,  HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TWENTY_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_STYLISTIC_ALT_TWENTY_OFF},
 165   {HB_TAG ('s','u','b','s'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION,       HB_AAT_LAYOUT_FEATURE_SELECTOR_INFERIORS,                      HB_AAT_LAYOUT_FEATURE_SELECTOR_NORMAL_POSITION},
 166   {HB_TAG ('s','u','p','s'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_POSITION,       HB_AAT_LAYOUT_FEATURE_SELECTOR_SUPERIORS,                      HB_AAT_LAYOUT_FEATURE_SELECTOR_NORMAL_POSITION},
 167   {HB_TAG ('s','w','s','h'), HB_AAT_LAYOUT_FEATURE_TYPE_CONTEXTUAL_ALTERNATIVES, HB_AAT_LAYOUT_FEATURE_SELECTOR_SWASH_ALTERNATES_ON,            HB_AAT_LAYOUT_FEATURE_SELECTOR_SWASH_ALTERNATES_OFF},
 168   {HB_TAG ('t','i','t','l'), HB_AAT_LAYOUT_FEATURE_TYPE_STYLE_OPTIONS,           HB_AAT_LAYOUT_FEATURE_SELECTOR_TITLING_CAPS,                   HB_AAT_LAYOUT_FEATURE_SELECTOR_NO_STYLE_OPTIONS},
 169   {HB_TAG ('t','n','a','m'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_TRADITIONAL_NAMES_CHARACTERS,   (hb_aat_layout_feature_selector_t) 16},
 170   {HB_TAG ('t','n','u','m'), HB_AAT_LAYOUT_FEATURE_TYPE_NUMBER_SPACING,          HB_AAT_LAYOUT_FEATURE_SELECTOR_MONOSPACED_NUMBERS,             (hb_aat_layout_feature_selector_t) 4},
 171   {HB_TAG ('t','r','a','d'), HB_AAT_LAYOUT_FEATURE_TYPE_CHARACTER_SHAPE,         HB_AAT_LAYOUT_FEATURE_SELECTOR_TRADITIONAL_CHARACTERS,         (hb_aat_layout_feature_selector_t) 16},
 172   {HB_TAG ('t','w','i','d'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_THIRD_WIDTH_TEXT,               (hb_aat_layout_feature_selector_t) 7},
 173   {HB_TAG ('u','n','i','c'), HB_AAT_LAYOUT_FEATURE_TYPE_LETTER_CASE,             (hb_aat_layout_feature_selector_t) 14,                 (hb_aat_layout_feature_selector_t) 15},
 174   {HB_TAG ('v','a','l','t'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_ALT_PROPORTIONAL_TEXT,          (hb_aat_layout_feature_selector_t) 7},
 175   {HB_TAG ('v','e','r','t'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION,   HB_AAT_LAYOUT_FEATURE_SELECTOR_SUBSTITUTE_VERTICAL_FORMS_ON,   HB_AAT_LAYOUT_FEATURE_SELECTOR_SUBSTITUTE_VERTICAL_FORMS_OFF},
 176   {HB_TAG ('v','h','a','l'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_ALT_HALF_WIDTH_TEXT,            (hb_aat_layout_feature_selector_t) 7},
 177   {HB_TAG ('v','k','n','a'), HB_AAT_LAYOUT_FEATURE_TYPE_ALTERNATE_KANA,          HB_AAT_LAYOUT_FEATURE_SELECTOR_ALTERNATE_VERT_KANA_ON,         HB_AAT_LAYOUT_FEATURE_SELECTOR_ALTERNATE_VERT_KANA_OFF},
 178   {HB_TAG ('v','p','a','l'), HB_AAT_LAYOUT_FEATURE_TYPE_TEXT_SPACING,            HB_AAT_LAYOUT_FEATURE_SELECTOR_ALT_PROPORTIONAL_TEXT,          (hb_aat_layout_feature_selector_t) 7},
 179   {HB_TAG ('v','r','t','2'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION,   HB_AAT_LAYOUT_FEATURE_SELECTOR_SUBSTITUTE_VERTICAL_FORMS_ON,   HB_AAT_LAYOUT_FEATURE_SELECTOR_SUBSTITUTE_VERTICAL_FORMS_OFF},
 180   {HB_TAG ('v','r','t','r'), HB_AAT_LAYOUT_FEATURE_TYPE_VERTICAL_SUBSTITUTION,   (hb_aat_layout_feature_selector_t) 2,                          (hb_aat_layout_feature_selector_t) 3},
 181   {HB_TAG ('z','e','r','o'), HB_AAT_LAYOUT_FEATURE_TYPE_TYPOGRAPHIC_EXTRAS,      HB_AAT_LAYOUT_FEATURE_SELECTOR_SLASHED_ZERO_ON,                HB_AAT_LAYOUT_FEATURE_SELECTOR_SLASHED_ZERO_OFF},
 182 };
 183
 184 /**
 185  * hb_aat_layout_find_feature_mapping:
 186  * @tag: The requested #hb_tag_t feature tag
 187  *
 188  * Fetches the AAT feature-and-selector combination that corresponds
 189  * to a given OpenType feature tag.
 190  *
 191  * Return value: the AAT features and selectors corresponding to the
 192  * OpenType feature tag queried
 193  *
 194  **/
 195 const hb_aat_feature_mapping_t *
 196 hb_aat_layout_find_feature_mapping (hb_tag_t tag)
 197 {
 198   return hb_sorted_array (feature_mappings).bsearch (tag);
 199 }
 200 #endif
 201
 202
 203 #ifndef HB_NO_AAT
 204
 205 /*
 206  * mort/morx/kerx/trak
 207  */
 208
 209
 210 void
 211 hb_aat_layout_compile_map (const hb_aat_map_builder_t *mapper,
 212                            hb_aat_map_t *map)
 213 {
 214   const AAT::morx& morx = *mapper->face->table.morx;
 215   if (morx.has_data ())
 216   {
 217     morx.compile_flags (mapper, map);
 218     return;
 219   }
 220
 221   const AAT::mort& mort = *mapper->face->table.mort;
 222   if (mort.has_data ())
 223   {
 224     mort.compile_flags (mapper, map);
 225     return;
 226   }
 227 }
 228
 229
 230 /**
 231  * hb_aat_layout_has_substitution:
 232  * @face: #hb_face_t to work upon
 233  *
 234  * Tests whether the specified face includes any substitutions in the
 235  * `morx` or `mort` tables.
 236  *
 237  * <note>Note: does not examine the `GSUB` table.</note>
 238  *
 239  * Return value: `true` if data found, `false` otherwise
 240  *
 241  * Since: 2.3.0
 242  */
 243 hb_bool_t
 244 hb_aat_layout_has_substitution (hb_face_t *face)
 245 {
 246   return face->table.morx->has_data () ||
 247          face->table.mort->has_data ();
 248 }
 249
 250 void
 251 hb_aat_layout_substitute (const hb_ot_shape_plan_t *plan,
 252                           hb_font_t *font,
 253                           hb_buffer_t *buffer,
 254                           const hb_feature_t *features,
 255                           unsigned num_features)
 256 {
 257   hb_aat_map_builder_t builder (font->face, plan->props);
 258   for (unsigned i = 0; i < num_features; i++)
 259     builder.add_feature (features[i]);
 260   hb_aat_map_t map;
 261   builder.compile (map);
 262
 263   hb_blob_t *morx_blob = font->face->table.morx.get_blob ();
 264   const AAT::morx& morx = *morx_blob->as<AAT::morx> ();
 265   if (morx.has_data ())
 266   {
 267     AAT::hb_aat_apply_context_t c (plan, font, buffer, morx_blob);
 268     if (!buffer->message (font, "start table morx")) return;
 269     morx.apply (&c, map);
 270     (void) buffer->message (font, "end table morx");
 271     return;
 272   }
 273
 274   hb_blob_t *mort_blob = font->face->table.mort.get_blob ();
 275   const AAT::mort& mort = *mort_blob->as<AAT::mort> ();
 276   if (mort.has_data ())
 277   {
 278     AAT::hb_aat_apply_context_t c (plan, font, buffer, mort_blob);
 279     if (!buffer->message (font, "start table mort")) return;
 280     mort.apply (&c, map);
 281     (void) buffer->message (font, "end table mort");
 282     return;
 283   }
 284 }
 285
 286 void
 287 hb_aat_layout_zero_width_deleted_glyphs (hb_buffer_t *buffer)
 288 {
 289   unsigned int count = buffer->len;
 290   hb_glyph_info_t *info = buffer->info;
 291   hb_glyph_position_t *pos = buffer->pos;
 292   for (unsigned int i = 0; i < count; i++)
 293     if (unlikely (info[i].codepoint == AAT::DELETED_GLYPH))
 294       pos[i].x_advance = pos[i].y_advance = pos[i].x_offset = pos[i].y_offset = 0;
 295 }
 296
 297 static bool
 298 is_deleted_glyph (const hb_glyph_info_t *info)
 299 {
 300   return info->codepoint == AAT::DELETED_GLYPH;
 301 }
 302
 303 void
 304 hb_aat_layout_remove_deleted_glyphs (hb_buffer_t *buffer)
 305 {
 306   buffer->delete_glyphs_inplace (is_deleted_glyph);
 307 }
 308
 309 /**
 310  * hb_aat_layout_has_positioning:
 311  * @face: #hb_face_t to work upon
 312  *
 313  * Tests whether the specified face includes any positioning information
 314  * in the `kerx` table.
 315  *
 316  * <note>Note: does not examine the `GPOS` table.</note>
 317  *
 318  * Return value: `true` if data found, `false` otherwise
 319  *
 320  * Since: 2.3.0
 321  */
 322 hb_bool_t
 323 hb_aat_layout_has_positioning (hb_face_t *face)
 324 {
 325   return face->table.kerx->has_data ();
 326 }
 327
 328 void
 329 hb_aat_layout_position (const hb_ot_shape_plan_t *plan,
 330                         hb_font_t *font,
 331                         hb_buffer_t *buffer)
 332 {
 333   hb_blob_t *kerx_blob = font->face->table.kerx.get_blob ();
 334   const AAT::kerx& kerx = *kerx_blob->as<AAT::kerx> ();
 335
 336   AAT::hb_aat_apply_context_t c (plan, font, buffer, kerx_blob);
 337   if (!buffer->message (font, "start table kerx")) return;
 338   c.set_ankr_table (font->face->table.ankr.get ());
 339   kerx.apply (&c);
 340   (void) buffer->message (font, "end table kerx");
 341 }
 342
 343
 344 /**
 345  * hb_aat_layout_has_tracking:
 346  * @face:: #hb_face_t to work upon
 347  *
 348  * Tests whether the specified face includes any tracking information
 349  * in the `trak` table.
 350  *
 351  * Return value: `true` if data found, `false` otherwise
 352  *
 353  * Since: 2.3.0
 354  */
 355 hb_bool_t
 356 hb_aat_layout_has_tracking (hb_face_t *face)
 357 {
 358   return face->table.trak->has_data ();
 359 }
 360
 361 void
 362 hb_aat_layout_track (const hb_ot_shape_plan_t *plan,
 363                      hb_font_t *font,
 364                      hb_buffer_t *buffer)
 365 {
 366   const AAT::trak& trak = *font->face->table.trak;
 367
 368   AAT::hb_aat_apply_context_t c (plan, font, buffer);
 369   trak.apply (&c);
 370 }
 371
 372 /**
 373  * hb_aat_layout_get_feature_types:
 374  * @face: #hb_face_t to work upon
 375  * @start_offset: offset of the first feature type to retrieve
 376  * @feature_count: (inout) (optional): Input = the maximum number of feature types to return;
 377  *                 Output = the actual number of feature types returned (may be zero)
 378  * @features: (out caller-allocates) (array length=feature_count): Array of feature types found
 379  *
 380  * Fetches a list of the AAT feature types included in the specified face.
 381  *
 382  * Return value: Number of all available feature types.
 383  *
 384  * Since: 2.2.0
 385  */
 386 unsigned int
 387 hb_aat_layout_get_feature_types (hb_face_t                    *face,
 388                                  unsigned int                  start_offset,
 389                                  unsigned int                 *feature_count, /* IN/OUT.  May be NULL. */
 390                                  hb_aat_layout_feature_type_t *features       /* OUT.     May be NULL. */)
 391 {
 392   return face->table.feat->get_feature_types (start_offset, feature_count, features);
 393 }
 394
 395 /**
 396  * hb_aat_layout_feature_type_get_name_id:
 397  * @face: #hb_face_t to work upon
 398  * @feature_type: The #hb_aat_layout_feature_type_t of the requested feature type
 399  *
 400  * Fetches the name identifier of the specified feature type in the face's `name` table.
 401  *
 402  * Return value: Name identifier of the requested feature type
 403  *
 404  * Since: 2.2.0
 405  */
 406 hb_ot_name_id_t
 407 hb_aat_layout_feature_type_get_name_id (hb_face_t                    *face,
 408                                         hb_aat_layout_feature_type_t  feature_type)
 409 {
 410   return face->table.feat->get_feature_name_id (feature_type);
 411 }
 412
 413 /**
 414  * hb_aat_layout_feature_type_get_selector_infos:
 415  * @face: #hb_face_t to work upon
 416  * @feature_type: The #hb_aat_layout_feature_type_t of the requested feature type
 417  * @start_offset: offset of the first feature type to retrieve
 418  * @selector_count: (inout) (optional): Input = the maximum number of selectors to return;
 419  *                  Output = the actual number of selectors returned (may be zero)
 420  * @selectors: (out caller-allocates) (array length=selector_count) (optional):
 421  *             A buffer pointer. The selectors available for the feature type queries.
 422  * @default_index: (out) (optional): The index of the feature's default selector, if any
 423  *
 424  * Fetches a list of the selectors available for the specified feature in the given face.
 425  *
 426  * If upon return, @default_index is set to #HB_AAT_LAYOUT_NO_SELECTOR_INDEX, then
 427  * the feature type is non-exclusive.  Otherwise, @default_index is the index of
 428  * the selector that is selected by default.
 429  *
 430  * Return value: Number of all available feature selectors
 431  *
 432  * Since: 2.2.0
 433  */
 434 unsigned int
 435 hb_aat_layout_feature_type_get_selector_infos (hb_face_t                             *face,
 436                                                hb_aat_layout_feature_type_t           feature_type,
 437                                                unsigned int                           start_offset,
 438                                                unsigned int                          *selector_count, /* IN/OUT.  May be NULL. */
 439                                                hb_aat_layout_feature_selector_info_t *selectors,      /* OUT.     May be NULL. */
 440                                                unsigned int                          *default_index   /* OUT.     May be NULL. */)
 441 {
 442   return face->table.feat->get_selector_infos (feature_type, start_offset, selector_count, selectors, default_index);
 443 }
 444
 445
 446 #endif