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 (face->table.GDEF->table),
  59                                                        lookup_index (0)
  60 {
  61   sanitizer.init (blob);
  62   sanitizer.set_num_glyphs (face->get_num_glyphs ());
  63   sanitizer.start_processing ();
  64   sanitizer.set_max_ops (HB_SANITIZE_MAX_OPS_MAX);
  65 }
  66
  67 AAT::hb_aat_apply_context_t::~hb_aat_apply_context_t ()
  68 { sanitizer.end_processing (); }
  69
  70 void
  71 AAT::hb_aat_apply_context_t::set_ankr_table (const AAT::ankr *ankr_table_)
  72 { ankr_table = ankr_table_; }
  73
  74 #endif
  75
  76
  77 /**
  78  * SECTION:hb-aat-layout
  79  * @title: hb-aat-layout
  80  * @short_description: Apple Advanced Typography Layout
  81  * @include: hb-aat.h
  82  *
  83  * Functions for querying AAT Layout features in the font face.
  84  *
  85  * HarfBuzz supports all of the AAT tables used to implement shaping. Other
  86  * AAT tables and their associated features are not supported.
  87  **/
  88
  89
  90 #if !defined(HB_NO_AAT) || defined(HAVE_CORETEXT)
  91
  92 /* Mapping from OpenType feature tags to AAT feature names and selectors.
  93  *
  94  * Table data courtesy of Apple.  Converted from mnemonics to integers
  95  * when moving to this file. */
  96 static const hb_aat_feature_mapping_t feature_mappings[] =
  97 {
  98   {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},
  99   {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},
 100   {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},
 101   {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},
 102   {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},
 103   {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},
 104   {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},
 105   {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},
 106   {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},
 107   {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},
 108   {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},
 109   {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},
 110   {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},
 111   {HB_TAG ('h','i','s','t'), HB_AAT_LAYOUT_FEATURE_TYPE_LIGATURES,               HB_AAT_LAYOUT_FEATURE_SELECTOR_HISTORICAL_LIGATURES_ON,        HB_AAT_LAYOUT_FEATURE_SELECTOR_HISTORICAL_LIGATURES_OFF},
 112   {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},
 113   {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},
 114   {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},
 115   {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},
 116   {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},
 117   {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},
 118   {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},
 119   {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},
 120   {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},
 121   {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},
 122   {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},
 123   {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},
 124   {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},
 125   {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},
 126   {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},
 127   {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},
 128   {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},
 129   {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},
 130   {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},
 131   {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},
 132   {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},
 133   {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},
 134   {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},
 135   {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},
 136   {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},
 137   {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},
 138   {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},
 139   {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},
 140   {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},
 141   {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},
 142   {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},
 143   {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},
 144   {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},
 145   {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},
 146   {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},
 147   {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},
 148   {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},
 149   {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},
 150   {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},
 151   {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},
 152   {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},
 153   {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},
 154   {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},
 155   {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},
 156   {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},
 157   {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},
 158   {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},
 159   {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},
 160   {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},
 161   {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},
 162   {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},
 163   {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},
 164   {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},
 165   {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},
 166   {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},
 167   {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},
 168   {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},
 169   {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},
 170   {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},
 171   {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},
 172   {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},
 173   {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},
 174 };
 175
 176 /**
 177  * hb_aat_layout_find_feature_mapping:
 178  * @tag: The requested #hb_tag_t feature tag
 179  *
 180  * Fetches the AAT feature-and-selector combination that corresponds
 181  * to a given OpenType feature tag.
 182  *
 183  * Return value: the AAT features and selectors corresponding to the
 184  * OpenType feature tag queried
 185  *
 186  **/
 187 const hb_aat_feature_mapping_t *
 188 hb_aat_layout_find_feature_mapping (hb_tag_t tag)
 189 {
 190   return hb_sorted_array (feature_mappings).bsearch (tag);
 191 }
 192 #endif
 193
 194
 195 #ifndef HB_NO_AAT
 196
 197 /*
 198  * mort/morx/kerx/trak
 199  */
 200
 201
 202 void
 203 hb_aat_layout_compile_map (const hb_aat_map_builder_t *mapper,
 204                            hb_aat_map_t *map)
 205 {
 206   const AAT::morx& morx = *mapper->face->table.morx;
 207   if (morx.has_data ())
 208   {
 209     morx.compile_flags (mapper, map);
 210     return;
 211   }
 212
 213   const AAT::mort& mort = *mapper->face->table.mort;
 214   if (mort.has_data ())
 215   {
 216     mort.compile_flags (mapper, map);
 217     return;
 218   }
 219 }
 220
 221
 222 /**
 223  * hb_aat_layout_has_substitution:
 224  * @face: #hb_face_t to work upon
 225  *
 226  * Tests whether the specified face includes any substitutions in the
 227  * `morx` or `mort` tables.
 228  *
 229  * <note>Note: does not examine the `GSUB` table.</note>
 230  *
 231  * Return value: %true if data found, %false otherwise
 232  *
 233  * Since: 2.3.0
 234  */
 235 hb_bool_t
 236 hb_aat_layout_has_substitution (hb_face_t *face)
 237 {
 238   return face->table.morx->has_data () ||
 239          face->table.mort->has_data ();
 240 }
 241
 242 void
 243 hb_aat_layout_substitute (const hb_ot_shape_plan_t *plan,
 244                           hb_font_t *font,
 245                           hb_buffer_t *buffer)
 246 {
 247   hb_blob_t *morx_blob = font->face->table.morx.get_blob ();
 248   const AAT::morx& morx = *morx_blob->as<AAT::morx> ();
 249   if (morx.has_data ())
 250   {
 251     AAT::hb_aat_apply_context_t c (plan, font, buffer, morx_blob);
 252     if (!buffer->message (font, "start table morx")) return;
 253     morx.apply (&c);
 254     (void) buffer->message (font, "end table morx");
 255     return;
 256   }
 257
 258   hb_blob_t *mort_blob = font->face->table.mort.get_blob ();
 259   const AAT::mort& mort = *mort_blob->as<AAT::mort> ();
 260   if (mort.has_data ())
 261   {
 262     AAT::hb_aat_apply_context_t c (plan, font, buffer, mort_blob);
 263     if (!buffer->message (font, "start table mort")) return;
 264     mort.apply (&c);
 265     (void) buffer->message (font, "end table mort");
 266     return;
 267   }
 268 }
 269
 270 void
 271 hb_aat_layout_zero_width_deleted_glyphs (hb_buffer_t *buffer)
 272 {
 273   unsigned int count = buffer->len;
 274   hb_glyph_info_t *info = buffer->info;
 275   hb_glyph_position_t *pos = buffer->pos;
 276   for (unsigned int i = 0; i < count; i++)
 277     if (unlikely (info[i].codepoint == AAT::DELETED_GLYPH))
 278       pos[i].x_advance = pos[i].y_advance = pos[i].x_offset = pos[i].y_offset = 0;
 279 }
 280
 281 static bool
 282 is_deleted_glyph (const hb_glyph_info_t *info)
 283 {
 284   return info->codepoint == AAT::DELETED_GLYPH;
 285 }
 286
 287 void
 288 hb_aat_layout_remove_deleted_glyphs (hb_buffer_t *buffer)
 289 {
 290   hb_ot_layout_delete_glyphs_inplace (buffer, is_deleted_glyph);
 291 }
 292
 293 /**
 294  * hb_aat_layout_has_positioning:
 295  * @face: #hb_face_t to work upon
 296  *
 297  * Tests whether the specified face includes any positioning information
 298  * in the `kerx` table.
 299  *
 300  * <note>Note: does not examine the `GPOS` table.</note>
 301  *
 302  * Return value: %true if data found, %false otherwise
 303  *
 304  * Since: 2.3.0
 305  */
 306 hb_bool_t
 307 hb_aat_layout_has_positioning (hb_face_t *face)
 308 {
 309   return face->table.kerx->has_data ();
 310 }
 311
 312 void
 313 hb_aat_layout_position (const hb_ot_shape_plan_t *plan,
 314                         hb_font_t *font,
 315                         hb_buffer_t *buffer)
 316 {
 317   hb_blob_t *kerx_blob = font->face->table.kerx.get_blob ();
 318   const AAT::kerx& kerx = *kerx_blob->as<AAT::kerx> ();
 319
 320   AAT::hb_aat_apply_context_t c (plan, font, buffer, kerx_blob);
 321   if (!buffer->message (font, "start table kerx")) return;
 322   c.set_ankr_table (font->face->table.ankr.get ());
 323   kerx.apply (&c);
 324   (void) buffer->message (font, "end table kerx");
 325 }
 326
 327
 328 /**
 329  * hb_aat_layout_has_tracking:
 330  * @face:: #hb_face_t to work upon
 331  *
 332  * Tests whether the specified face includes any tracking information
 333  * in the `trak` table.
 334  *
 335  * Return value: %true if data found, %false otherwise
 336  *
 337  * Since: 2.3.0
 338  */
 339 hb_bool_t
 340 hb_aat_layout_has_tracking (hb_face_t *face)
 341 {
 342   return face->table.trak->has_data ();
 343 }
 344
 345 void
 346 hb_aat_layout_track (const hb_ot_shape_plan_t *plan,
 347                      hb_font_t *font,
 348                      hb_buffer_t *buffer)
 349 {
 350   const AAT::trak& trak = *font->face->table.trak;
 351
 352   AAT::hb_aat_apply_context_t c (plan, font, buffer);
 353   trak.apply (&c);
 354 }
 355
 356 /**
 357  * hb_aat_layout_get_feature_types:
 358  * @face: #hb_face_t to work upon
 359  * @start_offset: offset of the first feature type to retrieve
 360  * @feature_count: (inout) (optional): Input = the maximum number of feature types to return;
 361  *                 Output = the actual number of feature types returned (may be zero)
 362  * @features: (out caller-allocates) (array length=feature_count): Array of feature types found
 363  *
 364  * Fetches a list of the AAT feature types included in the specified face.
 365  *
 366  * Return value: Number of all available feature types.
 367  *
 368  * Since: 2.2.0
 369  */
 370 unsigned int
 371 hb_aat_layout_get_feature_types (hb_face_t                    *face,
 372                                  unsigned int                  start_offset,
 373                                  unsigned int                 *feature_count, /* IN/OUT.  May be NULL. */
 374                                  hb_aat_layout_feature_type_t *features       /* OUT.     May be NULL. */)
 375 {
 376   return face->table.feat->get_feature_types (start_offset, feature_count, features);
 377 }
 378
 379 /**
 380  * hb_aat_layout_feature_type_get_name_id:
 381  * @face: #hb_face_t to work upon
 382  * @feature_type: The #hb_aat_layout_feature_type_t of the requested feature type
 383  *
 384  * Fetches the name identifier of the specified feature type in the face's `name` table.
 385  *
 386  * Return value: Name identifier of the requested feature type
 387  *
 388  * Since: 2.2.0
 389  */
 390 hb_ot_name_id_t
 391 hb_aat_layout_feature_type_get_name_id (hb_face_t                    *face,
 392                                         hb_aat_layout_feature_type_t  feature_type)
 393 {
 394   return face->table.feat->get_feature_name_id (feature_type);
 395 }
 396
 397 /**
 398  * hb_aat_layout_feature_type_get_selector_infos:
 399  * @face: #hb_face_t to work upon
 400  * @feature_type: The #hb_aat_layout_feature_type_t of the requested feature type
 401  * @start_offset: offset of the first feature type to retrieve
 402  * @selector_count: (inout) (optional): Input = the maximum number of selectors to return;
 403  *                  Output = the actual number of selectors returned (may be zero)
 404  * @selectors: (out caller-allocates) (array length=selector_count) (optional):
 405  *             A buffer pointer. The selectors available for the feature type queries.
 406  * @default_index: (out) (optional): The index of the feature's default selector, if any
 407  *
 408  * Fetches a list of the selectors available for the specified feature in the given face.
 409  *
 410  * If upon return, @default_index is set to #HB_AAT_LAYOUT_NO_SELECTOR_INDEX, then
 411  * the feature type is non-exclusive.  Otherwise, @default_index is the index of
 412  * the selector that is selected by default.
 413  *
 414  * Return value: Number of all available feature selectors
 415  *
 416  * Since: 2.2.0
 417  */
 418 unsigned int
 419 hb_aat_layout_feature_type_get_selector_infos (hb_face_t                             *face,
 420                                                hb_aat_layout_feature_type_t           feature_type,
 421                                                unsigned int                           start_offset,
 422                                                unsigned int                          *selector_count, /* IN/OUT.  May be NULL. */
 423                                                hb_aat_layout_feature_selector_info_t *selectors,      /* OUT.     May be NULL. */
 424                                                unsigned int                          *default_index   /* OUT.     May be NULL. */)
 425 {
 426   return face->table.feat->get_selector_infos (feature_type, start_offset, selector_count, selectors, default_index);
 427 }
 428
 429
 430 #endif