src/hb-ot-shape-complex-arabic.cc

   1 /*
   2  * Copyright © 2010,2012  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-ot-shape-complex-private.hh"
  28 #include "hb-ot-shape-private.hh"
  29
  30
  31
  32 /* buffer var allocations */
  33 #define arabic_shaping_action() complex_var_u8_0() /* arabic shaping action */
  34
  35
  36 /*
  37  * Bits used in the joining tables
  38  */
  39 enum {
  40   JOINING_TYPE_U                = 0,
  41   JOINING_TYPE_R                = 1,
  42   JOINING_TYPE_D                = 2,
  43   JOINING_TYPE_C                = JOINING_TYPE_D,
  44   JOINING_GROUP_ALAPH           = 3,
  45   JOINING_GROUP_DALATH_RISH     = 4,
  46   NUM_STATE_MACHINE_COLS        = 5,
  47
  48   /* We deliberately don't have a JOINING_TYPE_L since that's unused in Unicode. */
  49
  50   JOINING_TYPE_T = 6,
  51   JOINING_TYPE_X = 7  /* means: use general-category to choose between U or T. */
  52 };
  53
  54 /*
  55  * Joining types:
  56  */
  57
  58 #include "hb-ot-shape-complex-arabic-table.hh"
  59
  60 static unsigned int get_joining_type (hb_codepoint_t u, hb_unicode_general_category_t gen_cat)
  61 {
  62   if (likely (hb_in_range<hb_codepoint_t> (u, JOINING_TABLE_FIRST, JOINING_TABLE_LAST))) {
  63     unsigned int j_type = joining_table[u - JOINING_TABLE_FIRST];
  64     if (likely (j_type != JOINING_TYPE_X))
  65       return j_type;
  66   }
  67
  68   /* Mongolian joining data is not in ArabicJoining.txt yet */
  69   if (unlikely (hb_in_range<hb_codepoint_t> (u, 0x1800, 0x18AF)))
  70   {
  71     /* All letters, SIBE SYLLABLE BOUNDARY MARKER, and NIRUGU are D */
  72     if (gen_cat == HB_UNICODE_GENERAL_CATEGORY_OTHER_LETTER || u == 0x1807 || u == 0x180A)
  73       return JOINING_TYPE_D;
  74   }
  75
  76   if (unlikely (hb_in_range<hb_codepoint_t> (u, 0x200C, 0x200D))) {
  77     return u == 0x200C ? JOINING_TYPE_U : JOINING_TYPE_C;
  78   }
  79
  80   return (FLAG(gen_cat) & (FLAG(HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK) | FLAG(HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK) | FLAG(HB_UNICODE_GENERAL_CATEGORY_FORMAT))) ?
  81          JOINING_TYPE_T : JOINING_TYPE_U;
  82 }
  83
  84 static hb_codepoint_t get_arabic_shape (hb_codepoint_t u, unsigned int shape)
  85 {
  86   if (likely (hb_in_range<hb_codepoint_t> (u, SHAPING_TABLE_FIRST, SHAPING_TABLE_LAST)) && shape < 4)
  87     return shaping_table[u - SHAPING_TABLE_FIRST][shape];
  88   return u;
  89 }
  90
  91 static uint16_t get_ligature (hb_codepoint_t first, hb_codepoint_t second)
  92 {
  93   if (unlikely (!second)) return 0;
  94   for (unsigned i = 0; i < ARRAY_LENGTH (ligature_table); i++)
  95     if (ligature_table[i].first == first)
  96       for (unsigned j = 0; j < ARRAY_LENGTH (ligature_table[i].ligatures); j++)
  97         if (ligature_table[i].ligatures[j].second == second)
  98           return ligature_table[i].ligatures[j].ligature;
  99   return 0;
 100 }
 101
 102 static const hb_tag_t arabic_features[] =
 103 {
 104   HB_TAG('i','n','i','t'),
 105   HB_TAG('m','e','d','i'),
 106   HB_TAG('f','i','n','a'),
 107   HB_TAG('i','s','o','l'),
 108   /* Syriac */
 109   HB_TAG('m','e','d','2'),
 110   HB_TAG('f','i','n','2'),
 111   HB_TAG('f','i','n','3'),
 112   HB_TAG_NONE
 113 };
 114
 115
 116 /* Same order as the feature array */
 117 enum {
 118   INIT,
 119   MEDI,
 120   FINA,
 121   ISOL,
 122
 123   /* Syriac */
 124   MED2,
 125   FIN2,
 126   FIN3,
 127
 128   NONE,
 129
 130   ARABIC_NUM_FEATURES = NONE
 131 };
 132
 133 static const struct arabic_state_table_entry {
 134         uint8_t prev_action;
 135         uint8_t curr_action;
 136         uint16_t next_state;
 137 } arabic_state_table[][NUM_STATE_MACHINE_COLS] =
 138 {
 139   /*   jt_U,          jt_R,          jt_D,          jg_ALAPH,      jg_DALATH_RISH */
 140
 141   /* State 0: prev was U, not willing to join. */
 142   { {NONE,NONE,0}, {NONE,ISOL,1}, {NONE,ISOL,2}, {NONE,ISOL,1}, {NONE,ISOL,6}, },
 143
 144   /* State 1: prev was R or ISOL/ALAPH, not willing to join. */
 145   { {NONE,NONE,0}, {NONE,ISOL,1}, {NONE,ISOL,2}, {NONE,FIN2,5}, {NONE,ISOL,6}, },
 146
 147   /* State 2: prev was D/ISOL, willing to join. */
 148   { {NONE,NONE,0}, {INIT,FINA,1}, {INIT,FINA,3}, {INIT,FINA,4}, {INIT,FINA,6}, },
 149
 150   /* State 3: prev was D/FINA, willing to join. */
 151   { {NONE,NONE,0}, {MEDI,FINA,1}, {MEDI,FINA,3}, {MEDI,FINA,4}, {MEDI,FINA,6}, },
 152
 153   /* State 4: prev was FINA ALAPH, not willing to join. */
 154   { {NONE,NONE,0}, {MED2,ISOL,1}, {MED2,ISOL,2}, {MED2,FIN2,5}, {MED2,ISOL,6}, },
 155
 156   /* State 5: prev was FIN2/FIN3 ALAPH, not willing to join. */
 157   { {NONE,NONE,0}, {ISOL,ISOL,1}, {ISOL,ISOL,2}, {ISOL,FIN2,5}, {ISOL,ISOL,6}, },
 158
 159   /* State 6: prev was DALATH/RISH, not willing to join. */
 160   { {NONE,NONE,0}, {NONE,ISOL,1}, {NONE,ISOL,2}, {NONE,FIN3,5}, {NONE,ISOL,6}, }
 161 };
 162
 163
 164
 165 static void
 166 collect_features_arabic (hb_ot_shape_planner_t *plan)
 167 {
 168   hb_ot_map_builder_t *map = &plan->map;
 169
 170   /* For Language forms (in ArabicOT speak), we do the iso/fina/medi/init together,
 171    * then rlig and calt each in their own stage.  This makes IranNastaliq's ALLAH
 172    * ligature work correctly. It's unfortunate though...
 173    *
 174    * This also makes Arial Bold in Windows7 work.  See:
 175    * https://bugzilla.mozilla.org/show_bug.cgi?id=644184
 176    *
 177    * TODO: Add test cases for these two.
 178    */
 179
 180   map->add_bool_feature (HB_TAG('c','c','m','p'));
 181   map->add_bool_feature (HB_TAG('l','o','c','l'));
 182
 183   map->add_gsub_pause (NULL);
 184
 185   for (unsigned int i = 0; i < ARABIC_NUM_FEATURES; i++)
 186     map->add_bool_feature (arabic_features[i], false);
 187
 188   map->add_gsub_pause (NULL);
 189
 190   map->add_bool_feature (HB_TAG('r','l','i','g'));
 191   map->add_gsub_pause (NULL);
 192
 193   map->add_bool_feature (HB_TAG('c','a','l','t'));
 194   map->add_gsub_pause (NULL);
 195
 196   /* ArabicOT spec enables 'cswh' for Arabic where as for basic shaper it's disabled by default. */
 197   map->add_bool_feature (HB_TAG('c','s','w','h'));
 198 }
 199
 200 struct arabic_shape_plan_t
 201 {
 202   ASSERT_POD ();
 203
 204   bool do_fallback;
 205   /* The "+ 1" in the next array is to accommodate for the "NONE" command,
 206    * which is not an OpenType feature, but this simplifies the code by not
 207    * having to do a "if (... < NONE) ..." and just rely on the fact that
 208    * mask_array[NONE] == 0. */
 209   hb_mask_t mask_array[ARABIC_NUM_FEATURES + 1];
 210 };
 211
 212 static void *
 213 data_create_arabic (const hb_ot_shape_plan_t *plan)
 214 {
 215   arabic_shape_plan_t *arabic_plan = (arabic_shape_plan_t *) calloc (1, sizeof (arabic_shape_plan_t));
 216   if (unlikely (!arabic_plan))
 217     return NULL;
 218
 219   hb_mask_t total_masks = 0;
 220   for (unsigned int i = 0; i < ARABIC_NUM_FEATURES; i++) {
 221     arabic_plan->mask_array[i] = plan->map.get_1_mask (arabic_features[i]);
 222     total_masks |= arabic_plan->mask_array[i];
 223   }
 224
 225   /* Pitfalls:
 226    * - This path fires if user force-set init/medi/fina/isol off,
 227    * - If font does not declare script 'arab', well, what to do?
 228    *   Most probably it's safe to assume that init/medi/fina/isol
 229    *   still mean Arabic shaping, although they do not have to.
 230    */
 231   arabic_plan->do_fallback = 0 == total_masks;
 232
 233   return arabic_plan;
 234 }
 235
 236 static void
 237 data_destroy_arabic (void *data)
 238 {
 239   free (data);
 240 }
 241
 242 static void
 243 arabic_fallback_shape (hb_font_t *font, hb_buffer_t *buffer)
 244 {
 245   /* Only Arabic has presentation forms encoded in Unicode. */
 246   if (buffer->props.script != HB_SCRIPT_ARABIC)
 247     return;
 248
 249   unsigned int count = buffer->len;
 250   hb_codepoint_t glyph;
 251
 252   /* Shape to presentation forms */
 253   for (unsigned int i = 0; i < count; i++) {
 254     hb_codepoint_t u = buffer->info[i].codepoint;
 255     hb_codepoint_t shaped = get_arabic_shape (u, buffer->info[i].arabic_shaping_action());
 256     if (shaped != u && font->get_glyph (shaped, 0, &glyph))
 257       buffer->info[i].codepoint = shaped;
 258   }
 259
 260   /* Mandatory ligatures */
 261   buffer->clear_output ();
 262   for (buffer->idx = 0; buffer->idx + 1 < count;) {
 263     hb_codepoint_t ligature = get_ligature (buffer->cur().codepoint,
 264                                             buffer->cur(+1).codepoint);
 265     if (likely (!ligature) || !(font->get_glyph (ligature, 0, &glyph))) {
 266       buffer->next_glyph ();
 267       continue;
 268     }
 269
 270     buffer->replace_glyphs (2, 1, &ligature);
 271
 272     /* Technically speaking we can skip marks and stuff, like the GSUB path does.
 273      * But who cares, we're in fallback! */
 274   }
 275   for (; buffer->idx < count;)
 276       buffer->next_glyph ();
 277   buffer->swap_buffers ();
 278 }
 279
 280 static void
 281 arabic_joining (hb_buffer_t *buffer)
 282 {
 283   unsigned int count = buffer->len;
 284   unsigned int prev = 0, state = 0;
 285
 286   HB_BUFFER_ALLOCATE_VAR (buffer, arabic_shaping_action);
 287
 288   for (unsigned int i = 0; i < count; i++)
 289   {
 290     unsigned int this_type = get_joining_type (buffer->info[i].codepoint, _hb_glyph_info_get_general_category (&buffer->info[i]));
 291
 292     if (unlikely (this_type == JOINING_TYPE_T)) {
 293       buffer->info[i].arabic_shaping_action() = NONE;
 294       continue;
 295     }
 296
 297     const arabic_state_table_entry *entry = &arabic_state_table[state][this_type];
 298
 299     if (entry->prev_action != NONE)
 300       buffer->info[prev].arabic_shaping_action() = entry->prev_action;
 301
 302     buffer->info[i].arabic_shaping_action() = entry->curr_action;
 303
 304     prev = i;
 305     state = entry->next_state;
 306   }
 307
 308   HB_BUFFER_DEALLOCATE_VAR (buffer, arabic_shaping_action);
 309 }
 310
 311 static void
 312 preprocess_text_arabic (const hb_ot_shape_plan_t *plan,
 313                         hb_buffer_t              *buffer,
 314                         hb_font_t                *font)
 315 {
 316   const arabic_shape_plan_t *arabic_plan = (const arabic_shape_plan_t *) plan->data;
 317
 318   if (unlikely (arabic_plan->do_fallback))
 319   {
 320     arabic_joining (buffer);
 321     arabic_fallback_shape (font, buffer);
 322   }
 323 }
 324
 325 static void
 326 setup_masks_arabic (const hb_ot_shape_plan_t *plan,
 327                     hb_buffer_t              *buffer,
 328                     hb_font_t                *font)
 329 {
 330   const arabic_shape_plan_t *arabic_plan = (const arabic_shape_plan_t *) plan->data;
 331
 332   if (likely (!arabic_plan->do_fallback))
 333   {
 334     arabic_joining (buffer);
 335     unsigned int count = buffer->len;
 336     for (unsigned int i = 0; i < count; i++)
 337       buffer->info[i].mask |= arabic_plan->mask_array[buffer->info[i].arabic_shaping_action()];
 338   }
 339 }
 340
 341 const hb_ot_complex_shaper_t _hb_ot_complex_shaper_arabic =
 342 {
 343   "arabic",
 344   collect_features_arabic,
 345   NULL, /* override_features */
 346   data_create_arabic,
 347   data_destroy_arabic,
 348   preprocess_text_arabic,
 349   NULL, /* normalization_preference */
 350   setup_masks_arabic,
 351   true, /* zero_width_attached_marks */
 352 };