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

   1 /*
   2  * Copyright © 2011  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
  29 HB_BEGIN_DECLS
  30
  31
  32 /* buffer var allocations */
  33 #define indic_category() var2.u8[0] /* indic_category_t */
  34 #define indic_position() var2.u8[1] /* indic_matra_category_t */
  35
  36 #define INDIC_TABLE_ELEMENT_TYPE uint8_t
  37
  38 /* Cateories used in the OpenType spec:
  39  * https://www.microsoft.com/typography/otfntdev/devanot/shaping.aspx
  40  */
  41 /* Note: This enum is duplicated in the -machine.rl source file.
  42  * Not sure how to avoid duplication. */
  43 enum indic_category_t {
  44   OT_X = 0,
  45   OT_C,
  46   OT_Ra, /* Not explicitly listed in the OT spec, but used in the grammar. */
  47   OT_V,
  48   OT_N,
  49   OT_H,
  50   OT_ZWNJ,
  51   OT_ZWJ,
  52   OT_M,
  53   OT_SM,
  54   OT_VD,
  55   OT_A,
  56   OT_NBSP
  57 };
  58
  59 /* Categories used in IndicSyllabicCategory.txt from UCD */
  60 /* The assignments are guesswork */
  61 enum indic_syllabic_category_t {
  62   INDIC_SYLLABIC_CATEGORY_OTHER                 = OT_X,
  63
  64   INDIC_SYLLABIC_CATEGORY_AVAGRAHA              = OT_X,
  65   INDIC_SYLLABIC_CATEGORY_BINDU                 = OT_SM,
  66   INDIC_SYLLABIC_CATEGORY_CONSONANT             = OT_C,
  67   INDIC_SYLLABIC_CATEGORY_CONSONANT_DEAD        = OT_C,
  68   INDIC_SYLLABIC_CATEGORY_CONSONANT_FINAL       = OT_C,
  69   INDIC_SYLLABIC_CATEGORY_CONSONANT_HEAD_LETTER = OT_C,
  70   INDIC_SYLLABIC_CATEGORY_CONSONANT_MEDIAL      = OT_C,
  71   INDIC_SYLLABIC_CATEGORY_CONSONANT_PLACEHOLDER = OT_NBSP,
  72   INDIC_SYLLABIC_CATEGORY_CONSONANT_SUBJOINED   = OT_C,
  73   INDIC_SYLLABIC_CATEGORY_CONSONANT_REPHA       = OT_C,
  74   INDIC_SYLLABIC_CATEGORY_MODIFYING_LETTER      = OT_X,
  75   INDIC_SYLLABIC_CATEGORY_NUKTA                 = OT_N,
  76   INDIC_SYLLABIC_CATEGORY_REGISTER_SHIFTER      = OT_X,
  77   INDIC_SYLLABIC_CATEGORY_TONE_LETTER           = OT_X,
  78   INDIC_SYLLABIC_CATEGORY_TONE_MARK             = OT_X,
  79   INDIC_SYLLABIC_CATEGORY_VIRAMA                = OT_H,
  80   INDIC_SYLLABIC_CATEGORY_VISARGA               = OT_SM,
  81   INDIC_SYLLABIC_CATEGORY_VOWEL                 = OT_V,
  82   INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT       = OT_M,
  83   INDIC_SYLLABIC_CATEGORY_VOWEL_INDEPENDENT     = OT_V
  84 };
  85
  86 /* Categories used in IndicSMatraCategory.txt from UCD */
  87 enum indic_matra_category_t {
  88   INDIC_MATRA_CATEGORY_NOT_APPLICABLE           = 0,
  89
  90   INDIC_MATRA_CATEGORY_LEFT                     = 0x01,
  91   INDIC_MATRA_CATEGORY_TOP                      = 0x02,
  92   INDIC_MATRA_CATEGORY_BOTTOM                   = 0x04,
  93   INDIC_MATRA_CATEGORY_RIGHT                    = 0x08,
  94
  95   /* We don't really care much about these since we decompose them
  96    * in the generic pre-shaping layer. */
  97   INDIC_MATRA_CATEGORY_BOTTOM_AND_RIGHT         = INDIC_MATRA_CATEGORY_BOTTOM +
  98                                                   INDIC_MATRA_CATEGORY_RIGHT,
  99   INDIC_MATRA_CATEGORY_LEFT_AND_RIGHT           = INDIC_MATRA_CATEGORY_LEFT +
 100                                                   INDIC_MATRA_CATEGORY_RIGHT,
 101   INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM           = INDIC_MATRA_CATEGORY_TOP +
 102                                                   INDIC_MATRA_CATEGORY_BOTTOM,
 103   INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM_AND_RIGHT = INDIC_MATRA_CATEGORY_TOP +
 104                                                   INDIC_MATRA_CATEGORY_BOTTOM +
 105                                                   INDIC_MATRA_CATEGORY_RIGHT,
 106   INDIC_MATRA_CATEGORY_TOP_AND_LEFT             = INDIC_MATRA_CATEGORY_TOP +
 107                                                   INDIC_MATRA_CATEGORY_LEFT,
 108   INDIC_MATRA_CATEGORY_TOP_AND_LEFT_AND_RIGHT   = INDIC_MATRA_CATEGORY_TOP +
 109                                                   INDIC_MATRA_CATEGORY_LEFT +
 110                                                   INDIC_MATRA_CATEGORY_RIGHT,
 111   INDIC_MATRA_CATEGORY_TOP_AND_RIGHT            = INDIC_MATRA_CATEGORY_TOP +
 112                                                   INDIC_MATRA_CATEGORY_RIGHT,
 113
 114   INDIC_MATRA_CATEGORY_INVISIBLE                = INDIC_MATRA_CATEGORY_NOT_APPLICABLE,
 115   INDIC_MATRA_CATEGORY_OVERSTRUCK               = INDIC_MATRA_CATEGORY_NOT_APPLICABLE,
 116   INDIC_MATRA_CATEGORY_VISUAL_ORDER_LEFT        = INDIC_MATRA_CATEGORY_NOT_APPLICABLE
 117 };
 118
 119 #define INDIC_COMBINE_CATEGORIES(S,M) \
 120   (ASSERT_STATIC_EXPR (M == INDIC_MATRA_CATEGORY_NOT_APPLICABLE || (S == INDIC_SYLLABIC_CATEGORY_VIRAMA || S == INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT)), \
 121    ASSERT_STATIC_EXPR (S < 16 && M < 16), \
 122    (M << 4) | S)
 123
 124 #include "hb-ot-shape-complex-indic-table.hh"
 125
 126 /* XXX
 127  * This is a hack for now.  We should:
 128  * 1. Move this data into the main Indic table,
 129  * and/or
 130  * 2. Probe font lookups to determine consonant positions.
 131  */
 132 static const struct {
 133   hb_codepoint_t u;
 134   indic_matra_category_t position;
 135 } consonant_positions[] = {
 136   {0x0930, INDIC_MATRA_CATEGORY_BOTTOM},
 137   {0x09AC, INDIC_MATRA_CATEGORY_BOTTOM},
 138   {0x09AF, INDIC_MATRA_CATEGORY_RIGHT},
 139   {0x09B0, INDIC_MATRA_CATEGORY_BOTTOM},
 140   {0x09F0, INDIC_MATRA_CATEGORY_BOTTOM},
 141   {0x0A2F, INDIC_MATRA_CATEGORY_RIGHT},
 142   {0x0A30, INDIC_MATRA_CATEGORY_BOTTOM},
 143   {0x0A35, INDIC_MATRA_CATEGORY_BOTTOM},
 144   {0x0A39, INDIC_MATRA_CATEGORY_BOTTOM},
 145   {0x0AB0, INDIC_MATRA_CATEGORY_BOTTOM},
 146   {0x0B24, INDIC_MATRA_CATEGORY_BOTTOM},
 147   {0x0B28, INDIC_MATRA_CATEGORY_BOTTOM},
 148   {0x0B2C, INDIC_MATRA_CATEGORY_BOTTOM},
 149   {0x0B2D, INDIC_MATRA_CATEGORY_BOTTOM},
 150   {0x0B2E, INDIC_MATRA_CATEGORY_BOTTOM},
 151   {0x0B2F, INDIC_MATRA_CATEGORY_RIGHT},
 152   {0x0B30, INDIC_MATRA_CATEGORY_BOTTOM},
 153   {0x0B32, INDIC_MATRA_CATEGORY_BOTTOM},
 154   {0x0B33, INDIC_MATRA_CATEGORY_BOTTOM},
 155   {0x0B5F, INDIC_MATRA_CATEGORY_RIGHT},
 156   {0x0B71, INDIC_MATRA_CATEGORY_BOTTOM},
 157   {0x0C15, INDIC_MATRA_CATEGORY_BOTTOM},
 158   {0x0C16, INDIC_MATRA_CATEGORY_BOTTOM},
 159   {0x0C17, INDIC_MATRA_CATEGORY_BOTTOM},
 160   {0x0C18, INDIC_MATRA_CATEGORY_BOTTOM},
 161   {0x0C19, INDIC_MATRA_CATEGORY_BOTTOM},
 162   {0x0C1A, INDIC_MATRA_CATEGORY_BOTTOM},
 163   {0x0C1B, INDIC_MATRA_CATEGORY_BOTTOM},
 164   {0x0C1C, INDIC_MATRA_CATEGORY_BOTTOM},
 165   {0x0C1D, INDIC_MATRA_CATEGORY_BOTTOM},
 166   {0x0C1E, INDIC_MATRA_CATEGORY_BOTTOM},
 167   {0x0C1F, INDIC_MATRA_CATEGORY_BOTTOM},
 168   {0x0C20, INDIC_MATRA_CATEGORY_BOTTOM},
 169   {0x0C21, INDIC_MATRA_CATEGORY_BOTTOM},
 170   {0x0C22, INDIC_MATRA_CATEGORY_BOTTOM},
 171   {0x0C23, INDIC_MATRA_CATEGORY_BOTTOM},
 172   {0x0C24, INDIC_MATRA_CATEGORY_BOTTOM},
 173   {0x0C25, INDIC_MATRA_CATEGORY_BOTTOM},
 174   {0x0C26, INDIC_MATRA_CATEGORY_BOTTOM},
 175   {0x0C27, INDIC_MATRA_CATEGORY_BOTTOM},
 176   {0x0C28, INDIC_MATRA_CATEGORY_BOTTOM},
 177   {0x0C2A, INDIC_MATRA_CATEGORY_BOTTOM},
 178   {0x0C2B, INDIC_MATRA_CATEGORY_BOTTOM},
 179   {0x0C2C, INDIC_MATRA_CATEGORY_BOTTOM},
 180   {0x0C2D, INDIC_MATRA_CATEGORY_BOTTOM},
 181   {0x0C2E, INDIC_MATRA_CATEGORY_BOTTOM},
 182   {0x0C2F, INDIC_MATRA_CATEGORY_BOTTOM},
 183   {0x0C30, INDIC_MATRA_CATEGORY_BOTTOM},
 184   {0x0C32, INDIC_MATRA_CATEGORY_BOTTOM},
 185   {0x0C33, INDIC_MATRA_CATEGORY_BOTTOM},
 186   {0x0C35, INDIC_MATRA_CATEGORY_BOTTOM},
 187   {0x0C36, INDIC_MATRA_CATEGORY_BOTTOM},
 188   {0x0C37, INDIC_MATRA_CATEGORY_BOTTOM},
 189   {0x0C38, INDIC_MATRA_CATEGORY_BOTTOM},
 190   {0x0C39, INDIC_MATRA_CATEGORY_BOTTOM},
 191   {0x0C95, INDIC_MATRA_CATEGORY_BOTTOM},
 192   {0x0C96, INDIC_MATRA_CATEGORY_BOTTOM},
 193   {0x0C97, INDIC_MATRA_CATEGORY_BOTTOM},
 194   {0x0C98, INDIC_MATRA_CATEGORY_BOTTOM},
 195   {0x0C99, INDIC_MATRA_CATEGORY_BOTTOM},
 196   {0x0C9A, INDIC_MATRA_CATEGORY_BOTTOM},
 197   {0x0C9B, INDIC_MATRA_CATEGORY_BOTTOM},
 198   {0x0C9C, INDIC_MATRA_CATEGORY_BOTTOM},
 199   {0x0C9D, INDIC_MATRA_CATEGORY_BOTTOM},
 200   {0x0C9E, INDIC_MATRA_CATEGORY_BOTTOM},
 201   {0x0C9F, INDIC_MATRA_CATEGORY_BOTTOM},
 202   {0x0CA0, INDIC_MATRA_CATEGORY_BOTTOM},
 203   {0x0CA1, INDIC_MATRA_CATEGORY_BOTTOM},
 204   {0x0CA2, INDIC_MATRA_CATEGORY_BOTTOM},
 205   {0x0CA3, INDIC_MATRA_CATEGORY_BOTTOM},
 206   {0x0CA4, INDIC_MATRA_CATEGORY_BOTTOM},
 207   {0x0CA5, INDIC_MATRA_CATEGORY_BOTTOM},
 208   {0x0CA6, INDIC_MATRA_CATEGORY_BOTTOM},
 209   {0x0CA7, INDIC_MATRA_CATEGORY_BOTTOM},
 210   {0x0CA8, INDIC_MATRA_CATEGORY_BOTTOM},
 211   {0x0CAA, INDIC_MATRA_CATEGORY_BOTTOM},
 212   {0x0CAB, INDIC_MATRA_CATEGORY_BOTTOM},
 213   {0x0CAC, INDIC_MATRA_CATEGORY_BOTTOM},
 214   {0x0CAD, INDIC_MATRA_CATEGORY_BOTTOM},
 215   {0x0CAE, INDIC_MATRA_CATEGORY_BOTTOM},
 216   {0x0CAF, INDIC_MATRA_CATEGORY_BOTTOM},
 217   {0x0CB0, INDIC_MATRA_CATEGORY_BOTTOM},
 218   {0x0CB2, INDIC_MATRA_CATEGORY_BOTTOM},
 219   {0x0CB3, INDIC_MATRA_CATEGORY_BOTTOM},
 220   {0x0CB5, INDIC_MATRA_CATEGORY_BOTTOM},
 221   {0x0CB6, INDIC_MATRA_CATEGORY_BOTTOM},
 222   {0x0CB7, INDIC_MATRA_CATEGORY_BOTTOM},
 223   {0x0CB8, INDIC_MATRA_CATEGORY_BOTTOM},
 224   {0x0CB9, INDIC_MATRA_CATEGORY_BOTTOM},
 225   {0x0CDE, INDIC_MATRA_CATEGORY_BOTTOM},
 226   {0x0D2F, INDIC_MATRA_CATEGORY_RIGHT},
 227   {0x0D30, INDIC_MATRA_CATEGORY_RIGHT},
 228   {0x0D32, INDIC_MATRA_CATEGORY_BOTTOM},
 229   {0x0D35, INDIC_MATRA_CATEGORY_RIGHT},
 230 };
 231
 232
 233 static const struct {
 234   hb_tag_t tag;
 235   hb_bool_t is_global;
 236 } indic_basic_features[] =
 237 {
 238   {HB_TAG('n','u','k','t'), true},
 239   {HB_TAG('a','k','h','n'), false},
 240   {HB_TAG('r','p','h','f'), false},
 241   {HB_TAG('r','k','r','f'), false},
 242   {HB_TAG('p','r','e','f'), false},
 243   {HB_TAG('b','l','w','f'), false},
 244   {HB_TAG('h','a','l','f'), false},
 245   {HB_TAG('v','a','t','u'), true},
 246   {HB_TAG('p','s','t','f'), false},
 247   {HB_TAG('c','j','c','t'), true},
 248 };
 249
 250 /* Same order as the indic_basic_features array */
 251 enum {
 252   _NUKT,
 253   AKHN,
 254   RPHF,
 255   RKRF,
 256   PREF,
 257   BLWF,
 258   HALF,
 259   _VATU,
 260   PSTF,
 261   _CJCT,
 262 };
 263
 264 static const hb_tag_t indic_other_features[] =
 265 {
 266   HB_TAG('p','r','e','s'),
 267   HB_TAG('a','b','v','s'),
 268   HB_TAG('b','l','w','s'),
 269   HB_TAG('p','s','t','s'),
 270   HB_TAG('h','a','l','n'),
 271
 272   HB_TAG('d','i','s','t'),
 273   HB_TAG('a','b','v','m'),
 274   HB_TAG('b','l','w','m'),
 275 };
 276
 277
 278 void
 279 _hb_ot_shape_complex_collect_features_indic (hb_ot_shape_planner_t *planner, const hb_segment_properties_t *props HB_UNUSED)
 280 {
 281   for (unsigned int i = 0; i < ARRAY_LENGTH (indic_basic_features); i++)
 282     planner->map.add_bool_feature (indic_basic_features[i].tag, indic_basic_features[i].is_global);
 283
 284   for (unsigned int i = 0; i < ARRAY_LENGTH (indic_other_features); i++)
 285     planner->map.add_bool_feature (indic_other_features[i], true);
 286 }
 287
 288
 289
 290 #include "hb-ot-shape-complex-indic-machine.hh"
 291
 292
 293 void
 294 _hb_ot_shape_complex_setup_masks_indic  (hb_ot_shape_context_t *c)
 295 {
 296   unsigned int count = c->buffer->len;
 297
 298   for (unsigned int i = 0; i < count; i++)
 299   {
 300     unsigned int type = get_indic_categories (c->buffer->info[i].codepoint);
 301
 302     c->buffer->info[i].indic_category() = type & 0x0F;
 303     c->buffer->info[i].indic_position() = type >> 4;
 304   }
 305
 306   find_syllables (c);
 307
 308   hb_mask_t mask_array[ARRAY_LENGTH (indic_basic_features)] = {0};
 309   unsigned int num_masks = ARRAY_LENGTH (indic_basic_features);
 310   for (unsigned int i = 0; i < num_masks; i++)
 311     mask_array[i] = c->plan->map.get_1_mask (indic_basic_features[i].tag);
 312 }
 313
 314
 315 HB_END_DECLS