1 /*
   2  * Copyright © 2012,2013  Mozilla Foundation.
   3  * Copyright © 2012,2013  Google, Inc.
   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  * Mozilla Author(s): Jonathan Kew
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28 
  29 #define HB_SHAPER coretext
  30 #define hb_coretext_shaper_face_data_t CGFont
  31 #include "hb-shaper-impl-private.hh"
  32 
  33 #include "hb-coretext.h"
  34 
  35 
  36 #ifndef HB_DEBUG_CORETEXT
  37 #define HB_DEBUG_CORETEXT (HB_DEBUG+0)
  38 #endif
  39 
  40 
  41 static void
  42 release_table_data (void *user_data)
  43 {
  44   CFDataRef cf_data = reinterpret_cast<CFDataRef> (user_data);
  45   CFRelease(cf_data);
  46 }
  47 
  48 static hb_blob_t *
  49 reference_table  (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
  50 {
  51   CGFontRef cg_font = reinterpret_cast<CGFontRef> (user_data);
  52   CFDataRef cf_data = CGFontCopyTableForTag (cg_font, tag);
  53   if (unlikely (!cf_data))
  54     return NULL;
  55 
  56   const char *data = reinterpret_cast<const char*> (CFDataGetBytePtr (cf_data));
  57   const size_t length = CFDataGetLength (cf_data);
  58   if (!data || !length)
  59     return NULL;
  60 
  61   return hb_blob_create (data, length, HB_MEMORY_MODE_READONLY,
  62                          reinterpret_cast<void *> (const_cast<__CFData *> (cf_data)),
  63                          release_table_data);
  64 }
  65 
  66 hb_face_t *
  67 hb_coretext_face_create (CGFontRef cg_font)
  68 {
  69   return hb_face_create_for_tables (reference_table, CGFontRetain (cg_font), (hb_destroy_func_t) CGFontRelease);
  70 }
  71 
  72 
  73 HB_SHAPER_DATA_ENSURE_DECLARE(coretext, face)
  74 HB_SHAPER_DATA_ENSURE_DECLARE(coretext, font)
  75 
  76 
  77 /*
  78  * shaper face data
  79  */
  80 
  81 static void
  82 release_data (void *info, const void *data, size_t size)
  83 {
  84   assert (hb_blob_get_length ((hb_blob_t *) info) == size &&
  85           hb_blob_get_data ((hb_blob_t *) info, NULL) == data);
  86 
  87   hb_blob_destroy ((hb_blob_t *) info);
  88 }
  89 
  90 hb_coretext_shaper_face_data_t *
  91 _hb_coretext_shaper_face_data_create (hb_face_t *face)
  92 {
  93   hb_coretext_shaper_face_data_t *data = NULL;
  94 
  95   if (face->destroy == (hb_destroy_func_t) CGFontRelease)
  96   {
  97     data = CGFontRetain ((CGFontRef) face->user_data);
  98   }
  99   else
 100   {
 101     hb_blob_t *blob = hb_face_reference_blob (face);
 102     unsigned int blob_length;
 103     const char *blob_data = hb_blob_get_data (blob, &blob_length);
 104     if (unlikely (!blob_length))
 105       DEBUG_MSG (CORETEXT, face, "Face has empty blob");
 106 
 107     CGDataProviderRef provider = CGDataProviderCreateWithData (blob, blob_data, blob_length, &release_data);
 108     if (likely (provider))
 109     {
 110       data = CGFontCreateWithDataProvider (provider);
 111       CGDataProviderRelease (provider);
 112     }
 113   }
 114 
 115   if (unlikely (!data)) {
 116     DEBUG_MSG (CORETEXT, face, "Face CGFontCreateWithDataProvider() failed");
 117   }
 118 
 119   return data;
 120 }
 121 
 122 void
 123 _hb_coretext_shaper_face_data_destroy (hb_coretext_shaper_face_data_t *data)
 124 {
 125   CFRelease (data);
 126 }
 127 
 128 /*
 129  * Since: 0.9.10
 130  */
 131 CGFontRef
 132 hb_coretext_face_get_cg_font (hb_face_t *face)
 133 {
 134   if (unlikely (!hb_coretext_shaper_face_data_ensure (face))) return NULL;
 135   hb_coretext_shaper_face_data_t *face_data = HB_SHAPER_DATA_GET (face);
 136   return face_data;
 137 }
 138 
 139 
 140 /*
 141  * shaper font data
 142  */
 143 
 144 struct hb_coretext_shaper_font_data_t {
 145   CTFontRef ct_font;
 146   CGFloat x_mult, y_mult; /* From CT space to HB space. */
 147 };
 148 
 149 hb_coretext_shaper_font_data_t *
 150 _hb_coretext_shaper_font_data_create (hb_font_t *font)
 151 {
 152   if (unlikely (!hb_coretext_shaper_face_data_ensure (font->face))) return NULL;
 153 
 154   hb_coretext_shaper_font_data_t *data = (hb_coretext_shaper_font_data_t *) calloc (1, sizeof (hb_coretext_shaper_font_data_t));
 155   if (unlikely (!data))
 156     return NULL;
 157 
 158   hb_face_t *face = font->face;
 159   hb_coretext_shaper_face_data_t *face_data = HB_SHAPER_DATA_GET (face);
 160 
 161   /* Choose a CoreText font size and calculate multipliers to convert to HarfBuzz space. */
 162   /* TODO: use upem instead of 36? */
 163   CGFloat font_size = 36.; /* Default... */
 164   /* No idea if the following is even a good idea. */
 165   if (font->y_ppem)
 166     font_size = font->y_ppem;
 167 
 168   if (font_size < 0)
 169     font_size = -font_size;
 170   data->x_mult = (CGFloat) font->x_scale / font_size;
 171   data->y_mult = (CGFloat) font->y_scale / font_size;
 172   data->ct_font = CTFontCreateWithGraphicsFont (face_data, font_size, NULL, NULL);
 173   if (unlikely (!data->ct_font)) {
 174     DEBUG_MSG (CORETEXT, font, "Font CTFontCreateWithGraphicsFont() failed");
 175     free (data);
 176     return NULL;
 177   }
 178 
 179   return data;
 180 }
 181 
 182 void
 183 _hb_coretext_shaper_font_data_destroy (hb_coretext_shaper_font_data_t *data)
 184 {
 185   CFRelease (data->ct_font);
 186   free (data);
 187 }
 188 
 189 
 190 /*
 191  * shaper shape_plan data
 192  */
 193 
 194 struct hb_coretext_shaper_shape_plan_data_t {};
 195 
 196 hb_coretext_shaper_shape_plan_data_t *
 197 _hb_coretext_shaper_shape_plan_data_create (hb_shape_plan_t    *shape_plan HB_UNUSED,
 198                                              const hb_feature_t *user_features HB_UNUSED,
 199                                              unsigned int        num_user_features HB_UNUSED)
 200 {
 201   return (hb_coretext_shaper_shape_plan_data_t *) HB_SHAPER_DATA_SUCCEEDED;
 202 }
 203 
 204 void
 205 _hb_coretext_shaper_shape_plan_data_destroy (hb_coretext_shaper_shape_plan_data_t *data HB_UNUSED)
 206 {
 207 }
 208 
 209 CTFontRef
 210 hb_coretext_font_get_ct_font (hb_font_t *font)
 211 {
 212   if (unlikely (!hb_coretext_shaper_font_data_ensure (font))) return NULL;
 213   hb_coretext_shaper_font_data_t *font_data = HB_SHAPER_DATA_GET (font);
 214   return font_data->ct_font;
 215 }
 216 
 217 
 218 /*
 219  * shaper
 220  */
 221 
 222 struct feature_record_t {
 223   unsigned int feature;
 224   unsigned int setting;
 225 };
 226 
 227 struct active_feature_t {
 228   feature_record_t rec;
 229   unsigned int order;
 230 
 231   static int cmp (const active_feature_t *a, const active_feature_t *b) {
 232     return a->rec.feature < b->rec.feature ? -1 : a->rec.feature > b->rec.feature ? 1 :
 233            a->order < b->order ? -1 : a->order > b->order ? 1 :
 234            a->rec.setting < b->rec.setting ? -1 : a->rec.setting > b->rec.setting ? 1 :
 235            0;
 236   }
 237   bool operator== (const active_feature_t *f) {
 238     return cmp (this, f) == 0;
 239   }
 240 };
 241 
 242 struct feature_event_t {
 243   unsigned int index;
 244   bool start;
 245   active_feature_t feature;
 246 
 247   static int cmp (const feature_event_t *a, const feature_event_t *b) {
 248     return a->index < b->index ? -1 : a->index > b->index ? 1 :
 249            a->start < b->start ? -1 : a->start > b->start ? 1 :
 250            active_feature_t::cmp (&a->feature, &b->feature);
 251   }
 252 };
 253 
 254 struct range_record_t {
 255   CTFontRef font;
 256   unsigned int index_first; /* == start */
 257   unsigned int index_last;  /* == end - 1 */
 258 };
 259 
 260 
 261 /* The following enum members are added in OS X 10.8. */
 262 #define kAltHalfWidthTextSelector               6
 263 #define kAltProportionalTextSelector            5
 264 #define kAlternateHorizKanaOffSelector          1
 265 #define kAlternateHorizKanaOnSelector           0
 266 #define kAlternateKanaType                      34
 267 #define kAlternateVertKanaOffSelector           3
 268 #define kAlternateVertKanaOnSelector            2
 269 #define kCaseSensitiveLayoutOffSelector         1
 270 #define kCaseSensitiveLayoutOnSelector          0
 271 #define kCaseSensitiveLayoutType                33
 272 #define kCaseSensitiveSpacingOffSelector        3
 273 #define kCaseSensitiveSpacingOnSelector         2
 274 #define kContextualAlternatesOffSelector        1
 275 #define kContextualAlternatesOnSelector         0
 276 #define kContextualAlternatesType               36
 277 #define kContextualLigaturesOffSelector         19
 278 #define kContextualLigaturesOnSelector          18
 279 #define kContextualSwashAlternatesOffSelector   5
 280 #define kContextualSwashAlternatesOnSelector    4
 281 #define kDefaultLowerCaseSelector               0
 282 #define kDefaultUpperCaseSelector               0
 283 #define kHistoricalLigaturesOffSelector         21
 284 #define kHistoricalLigaturesOnSelector          20
 285 #define kHojoCharactersSelector                 12
 286 #define kJIS2004CharactersSelector              11
 287 #define kLowerCasePetiteCapsSelector            2
 288 #define kLowerCaseSmallCapsSelector             1
 289 #define kLowerCaseType                          37
 290 #define kMathematicalGreekOffSelector           11
 291 #define kMathematicalGreekOnSelector            10
 292 #define kNLCCharactersSelector                  13
 293 #define kQuarterWidthTextSelector               4
 294 #define kScientificInferiorsSelector            4
 295 #define kStylisticAltEightOffSelector           17
 296 #define kStylisticAltEightOnSelector            16
 297 #define kStylisticAltEighteenOffSelector        37
 298 #define kStylisticAltEighteenOnSelector         36
 299 #define kStylisticAltElevenOffSelector          23
 300 #define kStylisticAltElevenOnSelector           22
 301 #define kStylisticAltFifteenOffSelector         31
 302 #define kStylisticAltFifteenOnSelector          30
 303 #define kStylisticAltFiveOffSelector            11
 304 #define kStylisticAltFiveOnSelector             10
 305 #define kStylisticAltFourOffSelector            9
 306 #define kStylisticAltFourOnSelector             8
 307 #define kStylisticAltFourteenOffSelector        29
 308 #define kStylisticAltFourteenOnSelector         28
 309 #define kStylisticAltNineOffSelector            19
 310 #define kStylisticAltNineOnSelector             18
 311 #define kStylisticAltNineteenOffSelector        39
 312 #define kStylisticAltNineteenOnSelector         38
 313 #define kStylisticAltOneOffSelector             3
 314 #define kStylisticAltOneOnSelector              2
 315 #define kStylisticAltSevenOffSelector           15
 316 #define kStylisticAltSevenOnSelector            14
 317 #define kStylisticAltSeventeenOffSelector       35
 318 #define kStylisticAltSeventeenOnSelector        34
 319 #define kStylisticAltSixOffSelector             13
 320 #define kStylisticAltSixOnSelector              12
 321 #define kStylisticAltSixteenOffSelector         33
 322 #define kStylisticAltSixteenOnSelector          32
 323 #define kStylisticAltTenOffSelector             21
 324 #define kStylisticAltTenOnSelector              20
 325 #define kStylisticAltThirteenOffSelector        27
 326 #define kStylisticAltThirteenOnSelector         26
 327 #define kStylisticAltThreeOffSelector           7
 328 #define kStylisticAltThreeOnSelector            6
 329 #define kStylisticAltTwelveOffSelector          25
 330 #define kStylisticAltTwelveOnSelector           24
 331 #define kStylisticAltTwentyOffSelector          41
 332 #define kStylisticAltTwentyOnSelector           40
 333 #define kStylisticAltTwoOffSelector             5
 334 #define kStylisticAltTwoOnSelector              4
 335 #define kStylisticAlternativesType              35
 336 #define kSwashAlternatesOffSelector             3
 337 #define kSwashAlternatesOnSelector              2
 338 #define kThirdWidthTextSelector                 3
 339 #define kTraditionalNamesCharactersSelector     14
 340 #define kUpperCasePetiteCapsSelector            2
 341 #define kUpperCaseSmallCapsSelector             1
 342 #define kUpperCaseType                          38
 343 
 344 /* Table data courtesy of Apple. */
 345 static const struct feature_mapping_t {
 346     FourCharCode otFeatureTag;
 347     uint16_t aatFeatureType;
 348     uint16_t selectorToEnable;
 349     uint16_t selectorToDisable;
 350 } feature_mappings[] = {
 351     { 'c2pc',   kUpperCaseType,             kUpperCasePetiteCapsSelector,           kDefaultUpperCaseSelector },
 352     { 'c2sc',   kUpperCaseType,             kUpperCaseSmallCapsSelector,            kDefaultUpperCaseSelector },
 353     { 'calt',   kContextualAlternatesType,  kContextualAlternatesOnSelector,        kContextualAlternatesOffSelector },
 354     { 'case',   kCaseSensitiveLayoutType,   kCaseSensitiveLayoutOnSelector,         kCaseSensitiveLayoutOffSelector },
 355     { 'clig',   kLigaturesType,             kContextualLigaturesOnSelector,         kContextualLigaturesOffSelector },
 356     { 'cpsp',   kCaseSensitiveLayoutType,   kCaseSensitiveSpacingOnSelector,        kCaseSensitiveSpacingOffSelector },
 357     { 'cswh',   kContextualAlternatesType,  kContextualSwashAlternatesOnSelector,   kContextualSwashAlternatesOffSelector },
 358     { 'dlig',   kLigaturesType,             kRareLigaturesOnSelector,               kRareLigaturesOffSelector },
 359     { 'expt',   kCharacterShapeType,        kExpertCharactersSelector,              16 },
 360     { 'frac',   kFractionsType,             kDiagonalFractionsSelector,             kNoFractionsSelector },
 361     { 'fwid',   kTextSpacingType,           kMonospacedTextSelector,                7 },
 362     { 'halt',   kTextSpacingType,           kAltHalfWidthTextSelector,              7 },
 363     { 'hist',   kLigaturesType,             kHistoricalLigaturesOnSelector,         kHistoricalLigaturesOffSelector },
 364     { 'hkna',   kAlternateKanaType,         kAlternateHorizKanaOnSelector,          kAlternateHorizKanaOffSelector, },
 365     { 'hlig',   kLigaturesType,             kHistoricalLigaturesOnSelector,         kHistoricalLigaturesOffSelector },
 366     { 'hngl',   kTransliterationType,       kHanjaToHangulSelector,                 kNoTransliterationSelector },
 367     { 'hojo',   kCharacterShapeType,        kHojoCharactersSelector,                16 },
 368     { 'hwid',   kTextSpacingType,           kHalfWidthTextSelector,                 7 },
 369     { 'ital',   kItalicCJKRomanType,        kCJKItalicRomanOnSelector,              kCJKItalicRomanOffSelector },
 370     { 'jp04',   kCharacterShapeType,        kJIS2004CharactersSelector,             16 },
 371     { 'jp78',   kCharacterShapeType,        kJIS1978CharactersSelector,             16 },
 372     { 'jp83',   kCharacterShapeType,        kJIS1983CharactersSelector,             16 },
 373     { 'jp90',   kCharacterShapeType,        kJIS1990CharactersSelector,             16 },
 374     { 'liga',   kLigaturesType,             kCommonLigaturesOnSelector,             kCommonLigaturesOffSelector },
 375     { 'lnum',   kNumberCaseType,            kUpperCaseNumbersSelector,              2 },
 376     { 'mgrk',   kMathematicalExtrasType,    kMathematicalGreekOnSelector,           kMathematicalGreekOffSelector },
 377     { 'nlck',   kCharacterShapeType,        kNLCCharactersSelector,                 16 },
 378     { 'onum',   kNumberCaseType,            kLowerCaseNumbersSelector,              2 },
 379     { 'ordn',   kVerticalPositionType,      kOrdinalsSelector,                      kNormalPositionSelector },
 380     { 'palt',   kTextSpacingType,           kAltProportionalTextSelector,           7 },
 381     { 'pcap',   kLowerCaseType,             kLowerCasePetiteCapsSelector,           kDefaultLowerCaseSelector },
 382     { 'pkna',   kTextSpacingType,           kProportionalTextSelector,              7 },
 383     { 'pnum',   kNumberSpacingType,         kProportionalNumbersSelector,           4 },
 384     { 'pwid',   kTextSpacingType,           kProportionalTextSelector,              7 },
 385     { 'qwid',   kTextSpacingType,           kQuarterWidthTextSelector,              7 },
 386     { 'ruby',   kRubyKanaType,              kRubyKanaOnSelector,                    kRubyKanaOffSelector },
 387     { 'sinf',   kVerticalPositionType,      kScientificInferiorsSelector,           kNormalPositionSelector },
 388     { 'smcp',   kLowerCaseType,             kLowerCaseSmallCapsSelector,            kDefaultLowerCaseSelector },
 389     { 'smpl',   kCharacterShapeType,        kSimplifiedCharactersSelector,          16 },
 390     { 'ss01',   kStylisticAlternativesType, kStylisticAltOneOnSelector,             kStylisticAltOneOffSelector },
 391     { 'ss02',   kStylisticAlternativesType, kStylisticAltTwoOnSelector,             kStylisticAltTwoOffSelector },
 392     { 'ss03',   kStylisticAlternativesType, kStylisticAltThreeOnSelector,           kStylisticAltThreeOffSelector },
 393     { 'ss04',   kStylisticAlternativesType, kStylisticAltFourOnSelector,            kStylisticAltFourOffSelector },
 394     { 'ss05',   kStylisticAlternativesType, kStylisticAltFiveOnSelector,            kStylisticAltFiveOffSelector },
 395     { 'ss06',   kStylisticAlternativesType, kStylisticAltSixOnSelector,             kStylisticAltSixOffSelector },
 396     { 'ss07',   kStylisticAlternativesType, kStylisticAltSevenOnSelector,           kStylisticAltSevenOffSelector },
 397     { 'ss08',   kStylisticAlternativesType, kStylisticAltEightOnSelector,           kStylisticAltEightOffSelector },
 398     { 'ss09',   kStylisticAlternativesType, kStylisticAltNineOnSelector,            kStylisticAltNineOffSelector },
 399     { 'ss10',   kStylisticAlternativesType, kStylisticAltTenOnSelector,             kStylisticAltTenOffSelector },
 400     { 'ss11',   kStylisticAlternativesType, kStylisticAltElevenOnSelector,          kStylisticAltElevenOffSelector },
 401     { 'ss12',   kStylisticAlternativesType, kStylisticAltTwelveOnSelector,          kStylisticAltTwelveOffSelector },
 402     { 'ss13',   kStylisticAlternativesType, kStylisticAltThirteenOnSelector,        kStylisticAltThirteenOffSelector },
 403     { 'ss14',   kStylisticAlternativesType, kStylisticAltFourteenOnSelector,        kStylisticAltFourteenOffSelector },
 404     { 'ss15',   kStylisticAlternativesType, kStylisticAltFifteenOnSelector,         kStylisticAltFifteenOffSelector },
 405     { 'ss16',   kStylisticAlternativesType, kStylisticAltSixteenOnSelector,         kStylisticAltSixteenOffSelector },
 406     { 'ss17',   kStylisticAlternativesType, kStylisticAltSeventeenOnSelector,       kStylisticAltSeventeenOffSelector },
 407     { 'ss18',   kStylisticAlternativesType, kStylisticAltEighteenOnSelector,        kStylisticAltEighteenOffSelector },
 408     { 'ss19',   kStylisticAlternativesType, kStylisticAltNineteenOnSelector,        kStylisticAltNineteenOffSelector },
 409     { 'ss20',   kStylisticAlternativesType, kStylisticAltTwentyOnSelector,          kStylisticAltTwentyOffSelector },
 410     { 'subs',   kVerticalPositionType,      kInferiorsSelector,                     kNormalPositionSelector },
 411     { 'sups',   kVerticalPositionType,      kSuperiorsSelector,                     kNormalPositionSelector },
 412     { 'swsh',   kContextualAlternatesType,  kSwashAlternatesOnSelector,             kSwashAlternatesOffSelector },
 413     { 'titl',   kStyleOptionsType,          kTitlingCapsSelector,                   kNoStyleOptionsSelector },
 414     { 'tnam',   kCharacterShapeType,        kTraditionalNamesCharactersSelector,    16 },
 415     { 'tnum',   kNumberSpacingType,         kMonospacedNumbersSelector,             4 },
 416     { 'trad',   kCharacterShapeType,        kTraditionalCharactersSelector,         16 },
 417     { 'twid',   kTextSpacingType,           kThirdWidthTextSelector,                7 },
 418     { 'unic',   kLetterCaseType,            14,                                     15 },
 419     { 'valt',   kTextSpacingType,           kAltProportionalTextSelector,           7 },
 420     { 'vert',   kVerticalSubstitutionType,  kSubstituteVerticalFormsOnSelector,     kSubstituteVerticalFormsOffSelector },
 421     { 'vhal',   kTextSpacingType,           kAltHalfWidthTextSelector,              7 },
 422     { 'vkna',   kAlternateKanaType,         kAlternateVertKanaOnSelector,           kAlternateVertKanaOffSelector },
 423     { 'vpal',   kTextSpacingType,           kAltProportionalTextSelector,           7 },
 424     { 'vrt2',   kVerticalSubstitutionType,  kSubstituteVerticalFormsOnSelector,     kSubstituteVerticalFormsOffSelector },
 425     { 'zero',   kTypographicExtrasType,     kSlashedZeroOnSelector,                 kSlashedZeroOffSelector },
 426 };
 427 
 428 static int
 429 _hb_feature_mapping_cmp (const void *key_, const void *entry_)
 430 {
 431   unsigned int key = * (unsigned int *) key_;
 432   const feature_mapping_t * entry = (const feature_mapping_t *) entry_;
 433   return key < entry->otFeatureTag ? -1 :
 434          key > entry->otFeatureTag ? 1 :
 435          0;
 436 }
 437 
 438 hb_bool_t
 439 _hb_coretext_shape (hb_shape_plan_t    *shape_plan,
 440                     hb_font_t          *font,
 441                     hb_buffer_t        *buffer,
 442                     const hb_feature_t *features,
 443                     unsigned int        num_features)
 444 {
 445   hb_face_t *face = font->face;
 446   hb_coretext_shaper_face_data_t *face_data = HB_SHAPER_DATA_GET (face);
 447   hb_coretext_shaper_font_data_t *font_data = HB_SHAPER_DATA_GET (font);
 448 
 449   /* Attach marks to their bases, to match the 'ot' shaper.
 450    * Adapted from hb-ot-shape:hb_form_clusters().
 451    * Note that this only makes us be closer to the 'ot' shaper,
 452    * but by no means the same.  For example, if there's
 453    * B1 M1 B2 M2, and B1-B2 form a ligature, M2's cluster will
 454    * continue pointing to B2 even though B2 was merged into B1's
 455    * cluster... */
 456   {
 457     hb_unicode_funcs_t *unicode = buffer->unicode;
 458     unsigned int count = buffer->len;
 459     hb_glyph_info_t *info = buffer->info;
 460     for (unsigned int i = 1; i < count; i++)
 461       if (HB_UNICODE_GENERAL_CATEGORY_IS_MARK (unicode->general_category (info[i].codepoint)))
 462         buffer->merge_clusters (i - 1, i + 1);
 463   }
 464 
 465   hb_auto_array_t<feature_record_t> feature_records;
 466   hb_auto_array_t<range_record_t> range_records;
 467 
 468   /*
 469    * Set up features.
 470    * (copied + modified from code from hb-uniscribe.cc)
 471    */
 472   if (num_features)
 473   {
 474     /* Sort features by start/end events. */
 475     hb_auto_array_t<feature_event_t> feature_events;
 476     for (unsigned int i = 0; i < num_features; i++)
 477     {
 478       const feature_mapping_t * mapping = (const feature_mapping_t *) bsearch (&features[i].tag,
 479                                                                                feature_mappings,
 480                                                                                ARRAY_LENGTH (feature_mappings),
 481                                                                                sizeof (feature_mappings[0]),
 482                                                                                _hb_feature_mapping_cmp);
 483       if (!mapping)
 484         continue;
 485 
 486       active_feature_t feature;
 487       feature.rec.feature = mapping->aatFeatureType;
 488       feature.rec.setting = features[i].value ? mapping->selectorToEnable : mapping->selectorToDisable;
 489       feature.order = i;
 490 
 491       feature_event_t *event;
 492 
 493       event = feature_events.push ();
 494       if (unlikely (!event))
 495         goto fail_features;
 496       event->index = features[i].start;
 497       event->start = true;
 498       event->feature = feature;
 499 
 500       event = feature_events.push ();
 501       if (unlikely (!event))
 502         goto fail_features;
 503       event->index = features[i].end;
 504       event->start = false;
 505       event->feature = feature;
 506     }
 507     feature_events.qsort ();
 508     /* Add a strategic final event. */
 509     {
 510       active_feature_t feature;
 511       feature.rec.feature = HB_TAG_NONE;
 512       feature.rec.setting = 0;
 513       feature.order = num_features + 1;
 514 
 515       feature_event_t *event = feature_events.push ();
 516       if (unlikely (!event))
 517         goto fail_features;
 518       event->index = 0; /* This value does magic. */
 519       event->start = false;
 520       event->feature = feature;
 521     }
 522 
 523     /* Scan events and save features for each range. */
 524     hb_auto_array_t<active_feature_t> active_features;
 525     unsigned int last_index = 0;
 526     for (unsigned int i = 0; i < feature_events.len; i++)
 527     {
 528       feature_event_t *event = &feature_events[i];
 529 
 530       if (event->index != last_index)
 531       {
 532         /* Save a snapshot of active features and the range. */
 533         range_record_t *range = range_records.push ();
 534         if (unlikely (!range))
 535           goto fail_features;
 536 
 537         if (active_features.len)
 538         {
 539           CFMutableArrayRef features_array = CFArrayCreateMutable(kCFAllocatorDefault, 0, &kCFTypeArrayCallBacks);
 540 
 541           /* TODO sort and resolve conflicting features? */
 542           /* active_features.qsort (); */
 543           for (unsigned int j = 0; j < active_features.len; j++)
 544           {
 545             CFStringRef keys[2] = {
 546               kCTFontFeatureTypeIdentifierKey,
 547               kCTFontFeatureSelectorIdentifierKey
 548             };
 549             CFNumberRef values[2] = {
 550               CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &active_features[j].rec.feature),
 551               CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &active_features[j].rec.setting)
 552             };
 553             CFDictionaryRef dict = CFDictionaryCreate (kCFAllocatorDefault,
 554                                                        (const void **) keys,
 555                                                        (const void **) values,
 556                                                        2,
 557                                                        &kCFTypeDictionaryKeyCallBacks,
 558                                                        &kCFTypeDictionaryValueCallBacks);
 559             CFRelease (values[0]);
 560             CFRelease (values[1]);
 561 
 562             CFArrayAppendValue (features_array, dict);
 563             CFRelease (dict);
 564 
 565           }
 566 
 567           CFDictionaryRef attributes = CFDictionaryCreate (kCFAllocatorDefault,
 568                                                            (const void **) &kCTFontFeatureSettingsAttribute,
 569                                                            (const void **) &features_array,
 570                                                            1,
 571                                                            &kCFTypeDictionaryKeyCallBacks,
 572                                                            &kCFTypeDictionaryValueCallBacks);
 573           CFRelease (features_array);
 574 
 575           CTFontDescriptorRef font_desc = CTFontDescriptorCreateWithAttributes (attributes);
 576           CFRelease (attributes);
 577 
 578           range->font = CTFontCreateCopyWithAttributes (font_data->ct_font, 0.0, NULL, font_desc);
 579           CFRelease (font_desc);
 580         }
 581         else
 582         {
 583           range->font = NULL;
 584         }
 585 
 586         range->index_first = last_index;
 587         range->index_last  = event->index - 1;
 588 
 589         last_index = event->index;
 590       }
 591 
 592       if (event->start) {
 593         active_feature_t *feature = active_features.push ();
 594         if (unlikely (!feature))
 595           goto fail_features;
 596         *feature = event->feature;
 597       } else {
 598         active_feature_t *feature = active_features.find (&event->feature);
 599         if (feature)
 600           active_features.remove (feature - active_features.array);
 601       }
 602     }
 603 
 604     if (!range_records.len) /* No active feature found. */
 605       goto fail_features;
 606   }
 607   else
 608   {
 609   fail_features:
 610     num_features = 0;
 611   }
 612 
 613   unsigned int scratch_size;
 614   hb_buffer_t::scratch_buffer_t *scratch = buffer->get_scratch_buffer (&scratch_size);
 615 
 616 #define ALLOCATE_ARRAY(Type, name, len, on_no_room) \
 617   Type *name = (Type *) scratch; \
 618   { \
 619     unsigned int _consumed = DIV_CEIL ((len) * sizeof (Type), sizeof (*scratch)); \
 620     if (unlikely (_consumed > scratch_size)) \
 621     { \
 622       on_no_room; \
 623       assert (0); \
 624     } \
 625     scratch += _consumed; \
 626     scratch_size -= _consumed; \
 627   }
 628 
 629   ALLOCATE_ARRAY (UniChar, pchars, buffer->len * 2, /*nothing*/);
 630   unsigned int chars_len = 0;
 631   for (unsigned int i = 0; i < buffer->len; i++) {
 632     hb_codepoint_t c = buffer->info[i].codepoint;
 633     if (likely (c <= 0xFFFFu))
 634       pchars[chars_len++] = c;
 635     else if (unlikely (c > 0x10FFFFu))
 636       pchars[chars_len++] = 0xFFFDu;
 637     else {
 638       pchars[chars_len++] = 0xD800u + ((c - 0x10000u) >> 10);
 639       pchars[chars_len++] = 0xDC00u + ((c - 0x10000u) & ((1 << 10) - 1));
 640     }
 641   }
 642 
 643   ALLOCATE_ARRAY (unsigned int, log_clusters, chars_len, /*nothing*/);
 644   chars_len = 0;
 645   for (unsigned int i = 0; i < buffer->len; i++)
 646   {
 647     hb_codepoint_t c = buffer->info[i].codepoint;
 648     unsigned int cluster = buffer->info[i].cluster;
 649     log_clusters[chars_len++] = cluster;
 650     if (hb_in_range (c, 0x10000u, 0x10FFFFu))
 651       log_clusters[chars_len++] = cluster; /* Surrogates. */
 652   }
 653 
 654 #define FAIL(...) \
 655   HB_STMT_START { \
 656     DEBUG_MSG (CORETEXT, NULL, __VA_ARGS__); \
 657     ret = false; \
 658     goto fail; \
 659   } HB_STMT_END;
 660 
 661   bool ret = true;
 662   CFStringRef string_ref = NULL;
 663   CTLineRef line = NULL;
 664 
 665   if (0)
 666   {
 667 resize_and_retry:
 668     DEBUG_MSG (CORETEXT, buffer, "Buffer resize");
 669     /* string_ref uses the scratch-buffer for backing store, and line references
 670      * string_ref (via attr_string).  We must release those before resizing buffer. */
 671     assert (string_ref);
 672     assert (line);
 673     CFRelease (string_ref);
 674     CFRelease (line);
 675     string_ref = NULL;
 676     line = NULL;
 677 
 678     /* Get previous start-of-scratch-area, that we use later for readjusting
 679      * our existing scratch arrays. */
 680     unsigned int old_scratch_used;
 681     hb_buffer_t::scratch_buffer_t *old_scratch;
 682     old_scratch = buffer->get_scratch_buffer (&old_scratch_used);
 683     old_scratch_used = scratch - old_scratch;
 684 
 685     if (unlikely (!buffer->ensure (buffer->allocated * 2)))
 686       FAIL ("Buffer resize failed");
 687 
 688     /* Adjust scratch, pchars, and log_cluster arrays.  This is ugly, but really the
 689      * cleanest way to do without completely restructuring the rest of this shaper. */
 690     scratch = buffer->get_scratch_buffer (&scratch_size);
 691     pchars = reinterpret_cast<UniChar *> (((char *) scratch + ((char *) pchars - (char *) old_scratch)));
 692     log_clusters = reinterpret_cast<unsigned int *> (((char *) scratch + ((char *) log_clusters - (char *) old_scratch)));
 693     scratch += old_scratch_used;
 694     scratch_size -= old_scratch_used;
 695   }
 696 retry:
 697   {
 698     string_ref = CFStringCreateWithCharactersNoCopy (NULL,
 699                                                      pchars, chars_len,
 700                                                      kCFAllocatorNull);
 701     if (unlikely (!string_ref))
 702       FAIL ("CFStringCreateWithCharactersNoCopy failed");
 703 
 704     /* Create an attributed string, populate it, and create a line from it, then release attributed string. */
 705     {
 706       CFMutableAttributedStringRef attr_string = CFAttributedStringCreateMutable (kCFAllocatorDefault,
 707                                                                                   chars_len);
 708       if (unlikely (!attr_string))
 709         FAIL ("CFAttributedStringCreateMutable failed");
 710       CFAttributedStringReplaceString (attr_string, CFRangeMake (0, 0), string_ref);
 711       if (HB_DIRECTION_IS_VERTICAL (buffer->props.direction))
 712       {
 713         CFAttributedStringSetAttribute (attr_string, CFRangeMake (0, chars_len),
 714                                         kCTVerticalFormsAttributeName, kCFBooleanTrue);
 715       }
 716 
 717       if (buffer->props.language)
 718       {
 719 /* What's the iOS equivalent of this check?
 720  * The symbols was introduced in iOS 7.0.
 721  * At any rate, our fallback is safe and works fine. */
 722 #if MAC_OS_X_VERSION_MIN_REQUIRED < 1090
 723 #  define kCTLanguageAttributeName CFSTR ("NSLanguage")
 724 #endif
 725         CFStringRef lang = CFStringCreateWithCStringNoCopy (kCFAllocatorDefault,
 726                                                             hb_language_to_string (buffer->props.language),
 727                                                             kCFStringEncodingUTF8,
 728                                                             kCFAllocatorNull);
 729         if (unlikely (!lang))
 730           FAIL ("CFStringCreateWithCStringNoCopy failed");
 731         CFAttributedStringSetAttribute (attr_string, CFRangeMake (0, chars_len),
 732                                         kCTLanguageAttributeName, lang);
 733         CFRelease (lang);
 734       }
 735       CFAttributedStringSetAttribute (attr_string, CFRangeMake (0, chars_len),
 736                                       kCTFontAttributeName, font_data->ct_font);
 737 
 738       if (num_features)
 739       {
 740         unsigned int start = 0;
 741         range_record_t *last_range = &range_records[0];
 742         for (unsigned int k = 0; k < chars_len; k++)
 743         {
 744           range_record_t *range = last_range;
 745           while (log_clusters[k] < range->index_first)
 746             range--;
 747           while (log_clusters[k] > range->index_last)
 748             range++;
 749           if (range != last_range)
 750           {
 751             if (last_range->font)
 752               CFAttributedStringSetAttribute (attr_string, CFRangeMake (start, k - start),
 753                                               kCTFontAttributeName, last_range->font);
 754 
 755             start = k;
 756           }
 757 
 758           last_range = range;
 759         }
 760         if (start != chars_len && last_range->font)
 761           CFAttributedStringSetAttribute (attr_string, CFRangeMake (start, chars_len - start),
 762                                           kCTFontAttributeName, last_range->font);
 763       }
 764 
 765       int level = HB_DIRECTION_IS_FORWARD (buffer->props.direction) ? 0 : 1;
 766       CFNumberRef level_number = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &level);
 767       CFDictionaryRef options = CFDictionaryCreate (kCFAllocatorDefault,
 768                                                     (const void **) &kCTTypesetterOptionForcedEmbeddingLevel,
 769                                                     (const void **) &level_number,
 770                                                     1,
 771                                                     &kCFTypeDictionaryKeyCallBacks,
 772                                                     &kCFTypeDictionaryValueCallBacks);
 773       if (unlikely (!options))
 774         FAIL ("CFDictionaryCreate failed");
 775 
 776       CTTypesetterRef typesetter = CTTypesetterCreateWithAttributedStringAndOptions (attr_string, options);
 777       CFRelease (options);
 778       CFRelease (attr_string);
 779       if (unlikely (!typesetter))
 780         FAIL ("CTTypesetterCreateWithAttributedStringAndOptions failed");
 781 
 782       line = CTTypesetterCreateLine (typesetter, CFRangeMake(0, 0));
 783       CFRelease (typesetter);
 784       if (unlikely (!line))
 785         FAIL ("CTTypesetterCreateLine failed");
 786     }
 787 
 788     CFArrayRef glyph_runs = CTLineGetGlyphRuns (line);
 789     unsigned int num_runs = CFArrayGetCount (glyph_runs);
 790     DEBUG_MSG (CORETEXT, NULL, "Num runs: %d", num_runs);
 791 
 792     buffer->len = 0;
 793     uint32_t status_and = ~0, status_or = 0;
 794     double advances_so_far = 0;
 795     /* For right-to-left runs, CoreText returns the glyphs positioned such that
 796      * any trailing whitespace is to the left of (0,0).  Adjust coordinate system
 797      * to fix for that.  Test with any RTL string with trailing spaces.
 798      * https://code.google.com/p/chromium/issues/detail?id=469028
 799      */
 800     if (HB_DIRECTION_IS_BACKWARD (buffer->props.direction))
 801     {
 802       advances_so_far -= CTLineGetTrailingWhitespaceWidth (line);
 803       if (HB_DIRECTION_IS_VERTICAL (buffer->props.direction))
 804           advances_so_far = -advances_so_far;
 805     }
 806 
 807     const CFRange range_all = CFRangeMake (0, 0);
 808 
 809     for (unsigned int i = 0; i < num_runs; i++)
 810     {
 811       CTRunRef run = static_cast<CTRunRef>(CFArrayGetValueAtIndex (glyph_runs, i));
 812       CTRunStatus run_status = CTRunGetStatus (run);
 813       status_or  |= run_status;
 814       status_and &= run_status;
 815       DEBUG_MSG (CORETEXT, run, "CTRunStatus: %x", run_status);
 816       double run_advance = CTRunGetTypographicBounds (run, range_all, NULL, NULL, NULL);
 817       if (HB_DIRECTION_IS_VERTICAL (buffer->props.direction))
 818           run_advance = -run_advance;
 819       DEBUG_MSG (CORETEXT, run, "Run advance: %g", run_advance);
 820 
 821       /* CoreText does automatic font fallback (AKA "cascading") for  characters
 822        * not supported by the requested font, and provides no way to turn it off,
 823        * so we must detect if the returned run uses a font other than the requested
 824        * one and fill in the buffer with .notdef glyphs instead of random glyph
 825        * indices from a different font.
 826        */
 827       CFDictionaryRef attributes = CTRunGetAttributes (run);
 828       CTFontRef run_ct_font = static_cast<CTFontRef>(CFDictionaryGetValue (attributes, kCTFontAttributeName));
 829       if (!CFEqual (run_ct_font, font_data->ct_font))
 830       {
 831         /* The run doesn't use our main font instance.  We have to figure out
 832          * whether font fallback happened, or this is just CoreText giving us
 833          * another CTFont using the same underlying CGFont.  CoreText seems
 834          * to do that in a variety of situations, one of which being vertical
 835          * text, but also perhaps for caching reasons.
 836          *
 837          * First, see if it uses any of our subfonts created to set font features...
 838          *
 839          * Next, compare the CGFont to the one we used to create our fonts.
 840          * Even this doesn't work all the time.
 841          *
 842          * Finally, we compare PS names, which I don't think are unique...
 843          *
 844          * Looks like if we really want to be sure here we have to modify the
 845          * font to change the name table, similar to what we do in the uniscribe
 846          * backend.
 847          *
 848          * However, even that wouldn't work if we were passed in the CGFont to
 849          * begin with.
 850          *
 851          * Webkit uses a slightly different approach: it installs LastResort
 852          * as fallback chain, and then checks PS name of used font against
 853          * LastResort.  That one is safe for any font except for LastResort,
 854          * as opposed to ours, which can fail if we are using any uninstalled
 855          * font that has the same name as an installed font.
 856          *
 857          * See: http://github.com/behdad/harfbuzz/pull/36
 858          */
 859         bool matched = false;
 860         for (unsigned int i = 0; i < range_records.len; i++)
 861           if (range_records[i].font && CFEqual (run_ct_font, range_records[i].font))
 862           {
 863             matched = true;
 864             break;
 865           }
 866         if (!matched)
 867         {
 868           CGFontRef run_cg_font = CTFontCopyGraphicsFont (run_ct_font, 0);
 869           if (run_cg_font)
 870           {
 871             matched = CFEqual (run_cg_font, face_data);
 872             CFRelease (run_cg_font);
 873           }
 874         }
 875         if (!matched)
 876         {
 877           CFStringRef font_ps_name = CTFontCopyName (font_data->ct_font, kCTFontPostScriptNameKey);
 878           CFStringRef run_ps_name = CTFontCopyName (run_ct_font, kCTFontPostScriptNameKey);
 879           CFComparisonResult result = CFStringCompare (run_ps_name, font_ps_name, 0);
 880           CFRelease (run_ps_name);
 881           CFRelease (font_ps_name);
 882           if (result == kCFCompareEqualTo)
 883             matched = true;
 884         }
 885         if (!matched)
 886         {
 887           CFRange range = CTRunGetStringRange (run);
 888           DEBUG_MSG (CORETEXT, run, "Run used fallback font: %ld..%ld",
 889                      range.location, range.location + range.length);
 890           if (!buffer->ensure_inplace (buffer->len + range.length))
 891             goto resize_and_retry;
 892           hb_glyph_info_t *info = buffer->info + buffer->len;
 893 
 894           hb_codepoint_t notdef = 0;
 895           hb_direction_t dir = buffer->props.direction;
 896           hb_position_t x_advance, y_advance, x_offset, y_offset;
 897           hb_font_get_glyph_advance_for_direction (font, notdef, dir, &x_advance, &y_advance);
 898           hb_font_get_glyph_origin_for_direction (font, notdef, dir, &x_offset, &y_offset);
 899           hb_position_t advance = x_advance + y_advance;
 900           x_offset = -x_offset;
 901           y_offset = -y_offset;
 902 
 903           unsigned int old_len = buffer->len;
 904           for (CFIndex j = range.location; j < range.location + range.length; j++)
 905           {
 906               UniChar ch = CFStringGetCharacterAtIndex (string_ref, j);
 907               if (hb_in_range<UniChar> (ch, 0xDC00u, 0xDFFFu) && range.location < j)
 908               {
 909                 ch = CFStringGetCharacterAtIndex (string_ref, j - 1);
 910                 if (hb_in_range<UniChar> (ch, 0xD800u, 0xDBFFu))
 911                   /* This is the second of a surrogate pair.  Don't need .notdef
 912                    * for this one. */
 913                   continue;
 914               }
 915               if (buffer->unicode->is_default_ignorable (ch))
 916                 continue;
 917 
 918               info->codepoint = notdef;
 919               info->cluster = log_clusters[j];
 920 
 921               info->mask = advance;
 922               info->var1.i32 = x_offset;
 923               info->var2.i32 = y_offset;
 924 
 925               info++;
 926               buffer->len++;
 927           }
 928           if (HB_DIRECTION_IS_BACKWARD (buffer->props.direction))
 929             buffer->reverse_range (old_len, buffer->len);
 930           advances_so_far += run_advance;
 931           continue;
 932         }
 933       }
 934 
 935       unsigned int num_glyphs = CTRunGetGlyphCount (run);
 936       if (num_glyphs == 0)
 937         continue;
 938 
 939       if (!buffer->ensure_inplace (buffer->len + num_glyphs))
 940         goto resize_and_retry;
 941 
 942       hb_glyph_info_t *run_info = buffer->info + buffer->len;
 943 
 944       /* Testing used to indicate that CTRunGetGlyphsPtr, etc (almost?) always
 945        * succeed, and so copying data to our own buffer will be rare.  Reports
 946        * have it that this changed in OS X 10.10 Yosemite, and NULL is returned
 947        * frequently.  At any rate, we can test that codepath by setting USE_PTR
 948        * to false. */
 949 
 950 #define USE_PTR true
 951 
 952 #define SCRATCH_SAVE() \
 953   unsigned int scratch_size_saved = scratch_size; \
 954   hb_buffer_t::scratch_buffer_t *scratch_saved = scratch
 955 
 956 #define SCRATCH_RESTORE() \
 957   scratch_size = scratch_size_saved; \
 958   scratch = scratch_saved;
 959 
 960       { /* Setup glyphs */
 961         SCRATCH_SAVE();
 962         const CGGlyph* glyphs = USE_PTR ? CTRunGetGlyphsPtr (run) : NULL;
 963         if (!glyphs) {
 964           ALLOCATE_ARRAY (CGGlyph, glyph_buf, num_glyphs, goto resize_and_retry);
 965           CTRunGetGlyphs (run, range_all, glyph_buf);
 966           glyphs = glyph_buf;
 967         }
 968         const CFIndex* string_indices = USE_PTR ? CTRunGetStringIndicesPtr (run) : NULL;
 969         if (!string_indices) {
 970           ALLOCATE_ARRAY (CFIndex, index_buf, num_glyphs, goto resize_and_retry);
 971           CTRunGetStringIndices (run, range_all, index_buf);
 972           string_indices = index_buf;
 973         }
 974         hb_glyph_info_t *info = run_info;
 975         for (unsigned int j = 0; j < num_glyphs; j++)
 976         {
 977           info->codepoint = glyphs[j];
 978           info->cluster = log_clusters[string_indices[j]];
 979           info++;
 980         }
 981         SCRATCH_RESTORE();
 982       }
 983       {
 984         /* Setup positions.
 985          * Note that CoreText does not return advances for glyphs.  As such,
 986          * for all but last glyph, we use the delta position to next glyph as
 987          * advance (in the advance direction only), and for last glyph we set
 988          * whatever is needed to make the whole run's advance add up. */
 989         SCRATCH_SAVE();
 990         const CGPoint* positions = USE_PTR ? CTRunGetPositionsPtr (run) : NULL;
 991         if (!positions) {
 992           ALLOCATE_ARRAY (CGPoint, position_buf, num_glyphs, goto resize_and_retry);
 993           CTRunGetPositions (run, range_all, position_buf);
 994           positions = position_buf;
 995         }
 996         hb_glyph_info_t *info = run_info;
 997         CGFloat x_mult = font_data->x_mult, y_mult = font_data->y_mult;
 998         if (HB_DIRECTION_IS_HORIZONTAL (buffer->props.direction))
 999         {
1000           hb_position_t x_offset = (positions[0].x - advances_so_far) * x_mult;
1001           for (unsigned int j = 0; j < num_glyphs; j++)
1002           {
1003             double advance;
1004             if (likely (j + 1 < num_glyphs))
1005               advance = positions[j + 1].x - positions[j].x;
1006             else /* last glyph */
1007               advance = run_advance - (positions[j].x - positions[0].x);
1008             info->mask = advance * x_mult;
1009             info->var1.i32 = x_offset;
1010             info->var2.i32 = positions[j].y * y_mult;
1011             info++;
1012           }
1013         }
1014         else
1015         {
1016           hb_position_t y_offset = (positions[0].y - advances_so_far) * y_mult;
1017           for (unsigned int j = 0; j < num_glyphs; j++)
1018           {
1019             double advance;
1020             if (likely (j + 1 < num_glyphs))
1021               advance = positions[j + 1].y - positions[j].y;
1022             else /* last glyph */
1023               advance = run_advance - (positions[j].y - positions[0].y);
1024             info->mask = advance * y_mult;
1025             info->var1.i32 = positions[j].x * x_mult;
1026             info->var2.i32 = y_offset;
1027             info++;
1028           }
1029         }
1030         SCRATCH_RESTORE();
1031         advances_so_far += run_advance;
1032       }
1033 #undef SCRATCH_RESTORE
1034 #undef SCRATCH_SAVE
1035 #undef USE_PTR
1036 #undef ALLOCATE_ARRAY
1037 
1038       buffer->len += num_glyphs;
1039     }
1040 
1041     /* Mac OS 10.6 doesn't have kCTTypesetterOptionForcedEmbeddingLevel,
1042      * or if it does, it doesn't resepct it.  So we get runs with wrong
1043      * directions.  As such, disable the assert...  It wouldn't crash, but
1044      * cursoring will be off...
1045      *
1046      * http://crbug.com/419769
1047      */
1048     if (0)
1049     {
1050       /* Make sure all runs had the expected direction. */
1051       bool backward = HB_DIRECTION_IS_BACKWARD (buffer->props.direction);
1052       assert (bool (status_and & kCTRunStatusRightToLeft) == backward);
1053       assert (bool (status_or  & kCTRunStatusRightToLeft) == backward);
1054     }
1055 
1056     buffer->clear_positions ();
1057 
1058     unsigned int count = buffer->len;
1059     hb_glyph_info_t *info = buffer->info;
1060     hb_glyph_position_t *pos = buffer->pos;
1061     if (HB_DIRECTION_IS_HORIZONTAL (buffer->props.direction))
1062       for (unsigned int i = 0; i < count; i++)
1063       {
1064         pos->x_advance = info->mask;
1065         pos->x_offset = info->var1.i32;
1066         pos->y_offset = info->var2.i32;
1067         info++, pos++;
1068       }
1069     else
1070       for (unsigned int i = 0; i < count; i++)
1071       {
1072         pos->y_advance = info->mask;
1073         pos->x_offset = info->var1.i32;
1074         pos->y_offset = info->var2.i32;
1075         info++, pos++;
1076       }
1077 
1078     /* Fix up clusters so that we never return out-of-order indices;
1079      * if core text has reordered glyphs, we'll merge them to the
1080      * beginning of the reordered cluster.  CoreText is nice enough
1081      * to tell us whenever it has produced nonmonotonic results...
1082      * Note that we assume the input clusters were nonmonotonic to
1083      * begin with.
1084      *
1085      * This does *not* mean we'll form the same clusters as Uniscribe
1086      * or the native OT backend, only that the cluster indices will be
1087      * monotonic in the output buffer. */
1088     if (count > 1 && (status_or & kCTRunStatusNonMonotonic))
1089     {
1090       hb_glyph_info_t *info = buffer->info;
1091       if (HB_DIRECTION_IS_FORWARD (buffer->props.direction))
1092       {
1093         unsigned int cluster = info[count - 1].cluster;
1094         for (unsigned int i = count - 1; i > 0; i--)
1095         {
1096           cluster = MIN (cluster, info[i - 1].cluster);
1097           info[i - 1].cluster = cluster;
1098         }
1099       }
1100       else
1101       {
1102         unsigned int cluster = info[0].cluster;
1103         for (unsigned int i = 1; i < count; i++)
1104         {
1105           cluster = MIN (cluster, info[i].cluster);
1106           info[i].cluster = cluster;
1107         }
1108       }
1109     }
1110   }
1111 
1112 #undef FAIL
1113 
1114 fail:
1115   if (string_ref)
1116     CFRelease (string_ref);
1117   if (line)
1118     CFRelease (line);
1119 
1120   for (unsigned int i = 0; i < range_records.len; i++)
1121     if (range_records[i].font)
1122       CFRelease (range_records[i].font);
1123 
1124   return ret;
1125 }
1126 
1127 
1128 /*
1129  * AAT shaper
1130  */
1131 
1132 HB_SHAPER_DATA_ENSURE_DECLARE(coretext_aat, face)
1133 HB_SHAPER_DATA_ENSURE_DECLARE(coretext_aat, font)
1134 
1135 
1136 /*
1137  * shaper face data
1138  */
1139 
1140 struct hb_coretext_aat_shaper_face_data_t {};
1141 
1142 hb_coretext_aat_shaper_face_data_t *
1143 _hb_coretext_aat_shaper_face_data_create (hb_face_t *face)
1144 {
1145   hb_blob_t *mort_blob = face->reference_table (HB_CORETEXT_TAG_MORT);
1146   /* Umm, we just reference the table to check whether it exists.
1147    * Maybe add better API for this? */
1148   if (!hb_blob_get_length (mort_blob))
1149   {
1150     hb_blob_destroy (mort_blob);
1151     mort_blob = face->reference_table (HB_CORETEXT_TAG_MORX);
1152     if (!hb_blob_get_length (mort_blob))
1153     {
1154       hb_blob_destroy (mort_blob);
1155       return NULL;
1156     }
1157   }
1158   hb_blob_destroy (mort_blob);
1159 
1160   return hb_coretext_shaper_face_data_ensure (face) ? (hb_coretext_aat_shaper_face_data_t *) HB_SHAPER_DATA_SUCCEEDED : NULL;
1161 }
1162 
1163 void
1164 _hb_coretext_aat_shaper_face_data_destroy (hb_coretext_aat_shaper_face_data_t *data HB_UNUSED)
1165 {
1166 }
1167 
1168 
1169 /*
1170  * shaper font data
1171  */
1172 
1173 struct hb_coretext_aat_shaper_font_data_t {};
1174 
1175 hb_coretext_aat_shaper_font_data_t *
1176 _hb_coretext_aat_shaper_font_data_create (hb_font_t *font)
1177 {
1178   return hb_coretext_shaper_font_data_ensure (font) ? (hb_coretext_aat_shaper_font_data_t *) HB_SHAPER_DATA_SUCCEEDED : NULL;
1179 }
1180 
1181 void
1182 _hb_coretext_aat_shaper_font_data_destroy (hb_coretext_aat_shaper_font_data_t *data HB_UNUSED)
1183 {
1184 }
1185 
1186 
1187 /*
1188  * shaper shape_plan data
1189  */
1190 
1191 struct hb_coretext_aat_shaper_shape_plan_data_t {};
1192 
1193 hb_coretext_aat_shaper_shape_plan_data_t *
1194 _hb_coretext_aat_shaper_shape_plan_data_create (hb_shape_plan_t    *shape_plan HB_UNUSED,
1195                                              const hb_feature_t *user_features HB_UNUSED,
1196                                              unsigned int        num_user_features HB_UNUSED)
1197 {
1198   return (hb_coretext_aat_shaper_shape_plan_data_t *) HB_SHAPER_DATA_SUCCEEDED;
1199 }
1200 
1201 void
1202 _hb_coretext_aat_shaper_shape_plan_data_destroy (hb_coretext_aat_shaper_shape_plan_data_t *data HB_UNUSED)
1203 {
1204 }
1205 
1206 
1207 /*
1208  * shaper
1209  */
1210 
1211 hb_bool_t
1212 _hb_coretext_aat_shape (hb_shape_plan_t    *shape_plan,
1213                         hb_font_t          *font,
1214                         hb_buffer_t        *buffer,
1215                         const hb_feature_t *features,
1216                         unsigned int        num_features)
1217 {
1218   return _hb_coretext_shape (shape_plan, font, buffer, features, num_features);
1219 }