src/hb-ot-shape.cc

   1 /*
   2  * Copyright © 2009,2010  Red Hat, Inc.
   3  * Copyright © 2010,2011  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  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #include "hb-ot-shape-private.hh"
  30 #include "hb-ot-shape-complex-private.hh"
  31
  32 #include "hb-font-private.hh"
  33
  34 HB_BEGIN_DECLS
  35
  36
  37 hb_tag_t common_features[] = {
  38   HB_TAG('c','c','m','p'),
  39   HB_TAG('l','o','c','l'),
  40   HB_TAG('m','a','r','k'),
  41   HB_TAG('m','k','m','k'),
  42   HB_TAG('r','l','i','g'),
  43 };
  44
  45 hb_tag_t horizontal_features[] = {
  46   HB_TAG('c','a','l','t'),
  47   HB_TAG('c','l','i','g'),
  48   HB_TAG('c','u','r','s'),
  49   HB_TAG('k','e','r','n'),
  50   HB_TAG('l','i','g','a'),
  51 };
  52
  53 /* Note:
  54  * Technically speaking, vrt2 and vert are mutually exclusive.
  55  * According to the spec, valt and vpal are also mutually exclusive.
  56  * But we apply them all for now.
  57  */
  58 hb_tag_t vertical_features[] = {
  59   HB_TAG('v','a','l','t'),
  60   HB_TAG('v','e','r','t'),
  61   HB_TAG('v','k','r','n'),
  62   HB_TAG('v','p','a','l'),
  63   HB_TAG('v','r','t','2'),
  64 };
  65
  66 static void
  67 hb_ot_shape_collect_features (hb_ot_shape_planner_t          *planner,
  68                               const hb_segment_properties_t  *props,
  69                               const hb_feature_t             *user_features,
  70                               unsigned int                    num_user_features)
  71 {
  72   switch (props->direction) {
  73     case HB_DIRECTION_LTR:
  74       planner->map.add_bool_feature (HB_TAG ('l','t','r','a'));
  75       planner->map.add_bool_feature (HB_TAG ('l','t','r','m'));
  76       break;
  77     case HB_DIRECTION_RTL:
  78       planner->map.add_bool_feature (HB_TAG ('r','t','l','a'));
  79       planner->map.add_bool_feature (HB_TAG ('r','t','l','m'), false);
  80       break;
  81     case HB_DIRECTION_TTB:
  82     case HB_DIRECTION_BTT:
  83     case HB_DIRECTION_INVALID:
  84     default:
  85       break;
  86   }
  87
  88 #define ADD_FEATURES(array) \
  89   HB_STMT_START { \
  90     for (unsigned int i = 0; i < ARRAY_LENGTH (array); i++) \
  91       planner->map.add_bool_feature (array[i]); \
  92   } HB_STMT_END
  93
  94   hb_ot_shape_complex_collect_features (planner->shaper, &planner->map, props);
  95
  96   ADD_FEATURES (common_features);
  97
  98   if (HB_DIRECTION_IS_HORIZONTAL (props->direction))
  99     ADD_FEATURES (horizontal_features);
 100   else
 101     ADD_FEATURES (vertical_features);
 102
 103 #undef ADD_FEATURES
 104
 105   for (unsigned int i = 0; i < num_user_features; i++) {
 106     const hb_feature_t *feature = &user_features[i];
 107     planner->map.add_feature (feature->tag, feature->value, (feature->start == 0 && feature->end == (unsigned int) -1));
 108   }
 109 }
 110
 111
 112 static void
 113 hb_ot_shape_setup_masks (hb_ot_shape_context_t *c)
 114 {
 115   hb_mask_t global_mask = c->plan->map.get_global_mask ();
 116   c->buffer->reset_masks (global_mask);
 117
 118   hb_ot_shape_complex_setup_masks (c->plan->shaper, &c->plan->map, c->buffer); /* BUFFER: Clobbers var2 */
 119
 120   for (unsigned int i = 0; i < c->num_user_features; i++)
 121   {
 122     const hb_feature_t *feature = &c->user_features[i];
 123     if (!(feature->start == 0 && feature->end == (unsigned int)-1)) {
 124       unsigned int shift;
 125       hb_mask_t mask = c->plan->map.get_mask (feature->tag, &shift);
 126       c->buffer->set_masks (feature->value << shift, mask, feature->start, feature->end);
 127     }
 128   }
 129 }
 130
 131
 132 static void
 133 hb_ot_substitute_complex (hb_ot_shape_context_t *c)
 134 {
 135   if (!hb_ot_layout_has_substitution (c->face))
 136     return;
 137
 138   c->plan->map.substitute (c->face, c->buffer);
 139
 140   c->applied_substitute_complex = TRUE;
 141   return;
 142 }
 143
 144 static void
 145 hb_ot_position_complex (hb_ot_shape_context_t *c)
 146 {
 147
 148   if (!hb_ot_layout_has_positioning (c->face))
 149     return;
 150
 151   unsigned int count = c->buffer->len;
 152   for (unsigned int i = 0; i < count; i++) {
 153     hb_font_add_glyph_origin_for_direction (c->font, c->buffer->info[i].codepoint,
 154                                             HB_DIRECTION_LTR,
 155                                             &c->buffer->pos[i].x_offset,
 156                                             &c->buffer->pos[i].y_offset);
 157   }
 158
 159   c->plan->map.position (c->font, c->buffer);
 160
 161   for (unsigned int i = 0; i < count; i++) {
 162     hb_font_subtract_glyph_origin_for_direction (c->font, c->buffer->info[i].codepoint,
 163                                                  HB_DIRECTION_LTR,
 164                                                  &c->buffer->pos[i].x_offset,
 165                                                  &c->buffer->pos[i].y_offset);
 166   }
 167
 168   hb_ot_layout_position_finish (c->buffer);
 169
 170   c->applied_position_complex = TRUE;
 171   return;
 172 }
 173
 174
 175 /* Main shaper */
 176
 177 /* Prepare */
 178
 179 static inline hb_bool_t
 180 is_variation_selector (hb_codepoint_t unicode)
 181 {
 182   return unlikely ((unicode >=  0x180B && unicode <=  0x180D) || /* MONGOLIAN FREE VARIATION SELECTOR ONE..THREE */
 183                    (unicode >=  0xFE00 && unicode <=  0xFE0F) || /* VARIATION SELECTOR-1..16 */
 184                    (unicode >= 0xE0100 && unicode <= 0xE01EF));  /* VARIATION SELECTOR-17..256 */
 185 }
 186
 187 static void
 188 hb_set_unicode_props (hb_ot_shape_context_t *c)
 189 {
 190   hb_unicode_funcs_t *unicode = c->buffer->unicode;
 191   hb_glyph_info_t *info = c->buffer->info;
 192
 193   unsigned int count = c->buffer->len;
 194   for (unsigned int i = 1; i < count; i++) {
 195     info[i].general_category() = hb_unicode_general_category (unicode, info[i].codepoint);
 196     info[i].combining_class() = hb_unicode_combining_class (unicode, info[i].codepoint);
 197   }
 198 }
 199
 200 static void
 201 hb_form_clusters (hb_ot_shape_context_t *c)
 202 {
 203   unsigned int count = c->buffer->len;
 204   for (unsigned int i = 1; i < count; i++)
 205     if (FLAG (c->buffer->info[i].general_category()) &
 206         (FLAG (HB_UNICODE_GENERAL_CATEGORY_SPACING_MARK) |
 207          FLAG (HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK) |
 208          FLAG (HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK)) ||
 209         is_variation_selector (c->buffer->info[c->buffer->i].codepoint))
 210       c->buffer->info[i].cluster = c->buffer->info[i - 1].cluster;
 211 }
 212
 213 static void
 214 hb_ensure_native_direction (hb_ot_shape_context_t *c)
 215 {
 216   hb_direction_t direction = c->buffer->props.direction;
 217
 218   /* TODO vertical:
 219    * The only BTT vertical script is Ogham, but it's not clear to me whether OpenType
 220    * Ogham fonts are supposed to be implemented BTT or not.  Need to research that
 221    * first. */
 222   if ((HB_DIRECTION_IS_HORIZONTAL (direction) && direction != hb_script_get_horizontal_direction (c->buffer->props.script)) ||
 223       (HB_DIRECTION_IS_VERTICAL   (direction) && direction != HB_DIRECTION_TTB))
 224   {
 225     hb_buffer_reverse_clusters (c->buffer);
 226     c->buffer->props.direction = HB_DIRECTION_REVERSE (c->buffer->props.direction);
 227   }
 228 }
 229
 230 static void
 231 hb_reset_glyph_infos (hb_ot_shape_context_t *c)
 232 {
 233   unsigned int count = c->buffer->len;
 234   for (unsigned int i = 0; i < count; i++)
 235     c->buffer->info[i].var1.u32 = c->buffer->info[i].var2.u32 = 0;
 236 }
 237
 238
 239 /* Substitute */
 240
 241 static void
 242 hb_mirror_chars (hb_ot_shape_context_t *c)
 243 {
 244   hb_unicode_funcs_t *unicode = c->buffer->unicode;
 245
 246   if (HB_DIRECTION_IS_FORWARD (c->target_direction))
 247     return;
 248
 249   hb_mask_t rtlm_mask = c->plan->map.get_1_mask (HB_TAG ('r','t','l','m'));
 250
 251   unsigned int count = c->buffer->len;
 252   for (unsigned int i = 0; i < count; i++) {
 253     hb_codepoint_t codepoint = hb_unicode_mirroring (unicode, c->buffer->info[i].codepoint);
 254     if (likely (codepoint == c->buffer->info[i].codepoint))
 255       c->buffer->info[i].mask |= rtlm_mask; /* XXX this should be moved to before setting user-feature masks */
 256     else
 257       c->buffer->info[i].codepoint = codepoint;
 258   }
 259 }
 260
 261 static void
 262 hb_map_glyphs (hb_font_t    *font,
 263                hb_buffer_t  *buffer)
 264 {
 265   if (unlikely (!buffer->len))
 266     return;
 267
 268   hb_codepoint_t glyph;
 269   buffer->clear_output ();
 270   unsigned int count = buffer->len - 1;
 271   for (buffer->i = 0; buffer->i < count;) {
 272     if (unlikely (is_variation_selector (buffer->info[buffer->i + 1].codepoint))) {
 273       hb_font_get_glyph (font, buffer->info[buffer->i].codepoint, buffer->info[buffer->i + 1].codepoint, &glyph);
 274       buffer->replace_glyph (glyph);
 275       buffer->i++;
 276     } else {
 277       hb_font_get_glyph (font, buffer->info[buffer->i].codepoint, 0, &glyph);
 278       buffer->replace_glyph (glyph);
 279     }
 280   }
 281   if (likely (buffer->i < buffer->len)) {
 282     hb_font_get_glyph (font, buffer->info[buffer->i].codepoint, 0, &glyph);
 283     buffer->replace_glyph (glyph);
 284   }
 285   buffer->swap ();
 286 }
 287
 288 static void
 289 hb_substitute_default (hb_ot_shape_context_t *c)
 290 {
 291   hb_map_glyphs (c->font, c->buffer);
 292 }
 293
 294 static void
 295 hb_substitute_complex_fallback (hb_ot_shape_context_t *c HB_UNUSED)
 296 {
 297   /* TODO Arabic */
 298 }
 299
 300
 301 /* Position */
 302
 303 static void
 304 hb_position_default (hb_ot_shape_context_t *c)
 305 {
 306   hb_ot_layout_position_start (c->buffer);
 307
 308   unsigned int count = c->buffer->len;
 309   for (unsigned int i = 0; i < count; i++) {
 310     hb_font_get_glyph_advance_for_direction (c->font, c->buffer->info[i].codepoint,
 311                                              c->buffer->props.direction,
 312                                              &c->buffer->pos[i].x_advance,
 313                                              &c->buffer->pos[i].y_advance);
 314     hb_font_subtract_glyph_origin_for_direction (c->font, c->buffer->info[i].codepoint,
 315                                                  c->buffer->props.direction,
 316                                                  &c->buffer->pos[i].x_offset,
 317                                                  &c->buffer->pos[i].y_offset);
 318   }
 319 }
 320
 321 static void
 322 hb_position_complex_fallback (hb_ot_shape_context_t *c HB_UNUSED)
 323 {
 324   /* TODO Mark pos */
 325 }
 326
 327 static void
 328 hb_truetype_kern (hb_ot_shape_context_t *c)
 329 {
 330   /* TODO Check for kern=0 */
 331   unsigned int count = c->buffer->len;
 332   for (unsigned int i = 1; i < count; i++) {
 333     hb_position_t x_kern, y_kern, kern1, kern2;
 334     hb_font_get_glyph_kerning_for_direction (c->font,
 335                                              c->buffer->info[i - 1].codepoint, c->buffer->info[i].codepoint,
 336                                              c->buffer->props.direction,
 337                                              &x_kern, &y_kern);
 338
 339     kern1 = x_kern >> 1;
 340     kern2 = x_kern - kern1;
 341     c->buffer->pos[i - 1].x_advance += kern1;
 342     c->buffer->pos[i].x_advance += kern2;
 343     c->buffer->pos[i].x_offset += kern2;
 344
 345     kern1 = y_kern >> 1;
 346     kern2 = y_kern - kern1;
 347     c->buffer->pos[i - 1].y_advance += kern1;
 348     c->buffer->pos[i].y_advance += kern2;
 349     c->buffer->pos[i].y_offset += kern2;
 350   }
 351 }
 352
 353 static void
 354 hb_position_complex_fallback_visual (hb_ot_shape_context_t *c)
 355 {
 356   hb_truetype_kern (c);
 357 }
 358
 359
 360 /* Do it! */
 361
 362 static void
 363 hb_ot_shape_execute_internal (hb_ot_shape_context_t *c)
 364 {
 365   /* Save the original direction, we use it later. */
 366   c->target_direction = c->buffer->props.direction;
 367
 368   hb_reset_glyph_infos (c); /* BUFFER: Clear buffer var1 and var2 */
 369
 370   hb_set_unicode_props (c); /* BUFFER: Set general_category and combining_class in var1 */
 371
 372   hb_ensure_native_direction (c);
 373
 374   hb_form_clusters (c);
 375
 376   hb_ot_shape_setup_masks (c); /* BUFFER: Clobbers var2 */
 377
 378   /* SUBSTITUTE */
 379   {
 380     /* Mirroring needs to see the original direction */
 381     hb_mirror_chars (c);
 382
 383     hb_substitute_default (c);
 384
 385     hb_ot_substitute_complex (c);
 386
 387     if (!c->applied_substitute_complex)
 388       hb_substitute_complex_fallback (c);
 389   }
 390
 391   /* POSITION */
 392   {
 393     hb_position_default (c);
 394
 395     hb_ot_position_complex (c);
 396
 397     hb_bool_t position_fallback = !c->applied_position_complex;
 398     if (position_fallback)
 399       hb_position_complex_fallback (c);
 400
 401     if (HB_DIRECTION_IS_BACKWARD (c->buffer->props.direction))
 402       hb_buffer_reverse (c->buffer);
 403
 404     if (position_fallback)
 405       hb_position_complex_fallback_visual (c);
 406   }
 407
 408   c->buffer->props.direction = c->target_direction;
 409 }
 410
 411 static void
 412 hb_ot_shape_plan_internal (hb_ot_shape_plan_t       *plan,
 413                            hb_face_t                *face,
 414                            const hb_segment_properties_t  *props,
 415                            const hb_feature_t       *user_features,
 416                            unsigned int              num_user_features)
 417 {
 418   hb_ot_shape_planner_t planner;
 419
 420   planner.shaper = hb_ot_shape_complex_categorize (props);
 421
 422   hb_ot_shape_collect_features (&planner, props, user_features, num_user_features);
 423
 424   planner.compile (face, props, *plan);
 425 }
 426
 427 static void
 428 hb_ot_shape_execute (hb_ot_shape_plan_t *plan,
 429                      hb_font_t          *font,
 430                      hb_buffer_t        *buffer,
 431                      const hb_feature_t *user_features,
 432                      unsigned int        num_user_features)
 433 {
 434   hb_ot_shape_context_t c = {plan, font, font->face, buffer, user_features, num_user_features};
 435   hb_ot_shape_execute_internal (&c);
 436 }
 437
 438 void
 439 hb_ot_shape (hb_font_t          *font,
 440              hb_buffer_t        *buffer,
 441              const hb_feature_t *features,
 442              unsigned int        num_features)
 443 {
 444   hb_ot_shape_plan_t plan;
 445
 446   hb_ot_shape_plan_internal (&plan, font->face, &buffer->props, features, num_features);
 447   hb_ot_shape_execute (&plan, font, buffer, features, num_features);
 448 }
 449
 450
 451 HB_END_DECLS