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

   1 /*
   2  * Copyright (C) 2010  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 arabic_shaping_action() var2.u32 /* 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.h"
  59
  60 static unsigned int get_joining_type (hb_codepoint_t u, hb_category_t gen_cat)
  61 {
  62   /* TODO Macroize the magic bit operations */
  63
  64   if (likely (JOINING_TABLE_FIRST <= u && u <= JOINING_TABLE_LAST)) {
  65     unsigned int j_type = joining_table[u - JOINING_TABLE_FIRST];
  66     if (likely (j_type != JOINING_TYPE_X))
  67       return j_type;
  68   }
  69
  70   if (unlikely ((u & ~(0x200C^0x200D)) == 0x200C)) {
  71     return u == 0x200C ? JOINING_TYPE_U : JOINING_TYPE_C;
  72   }
  73
  74   return ((1<<gen_cat) & ((1<<HB_CATEGORY_NON_SPACING_MARK)|(1<<HB_CATEGORY_ENCLOSING_MARK)|(1<<HB_CATEGORY_FORMAT))) ?
  75          JOINING_TYPE_T : JOINING_TYPE_U;
  76 }
  77
  78
  79
  80 static const hb_tag_t arabic_syriac_features[] =
  81 {
  82   HB_TAG('i','n','i','t'),
  83   HB_TAG('m','e','d','i'),
  84   HB_TAG('f','i','n','a'),
  85   HB_TAG('i','s','o','l'),
  86   /* Syriac */
  87   HB_TAG('m','e','d','2'),
  88   HB_TAG('f','i','n','2'),
  89   HB_TAG('f','i','n','3'),
  90   HB_TAG_NONE
  91 };
  92
  93
  94 /* Same order as the feature array */
  95 enum {
  96   INIT,
  97   MEDI,
  98   FINA,
  99   ISOL,
 100
 101   /* Syriac */
 102   MED2,
 103   FIN2,
 104   FIN3,
 105
 106   NONE,
 107
 108   COMMON_NUM_FEATURES = 4,
 109   SYRIAC_NUM_FEATURES = 7,
 110   TOTAL_NUM_FEATURES = NONE
 111 };
 112
 113 static const struct arabic_state_table_entry {
 114         uint8_t prev_action;
 115         uint8_t curr_action;
 116         uint8_t next_state;
 117         uint8_t padding;
 118 } arabic_state_table[][NUM_STATE_MACHINE_COLS] =
 119 {
 120   /*   jt_U,          jt_R,          jt_D,          jg_ALAPH,      jg_DALATH_RISH */
 121
 122   /* State 0: prev was U, not willing to join. */
 123   { {NONE,NONE,0}, {NONE,ISOL,1}, {NONE,ISOL,2}, {NONE,ISOL,1}, {NONE,ISOL,6}, },
 124
 125   /* State 1: prev was R or ISOL/ALAPH, not willing to join. */
 126   { {NONE,NONE,0}, {NONE,ISOL,1}, {NONE,ISOL,2}, {NONE,FIN2,5}, {NONE,ISOL,6}, },
 127
 128   /* State 2: prev was D/ISOL, willing to join. */
 129   { {NONE,NONE,0}, {INIT,FINA,1}, {INIT,FINA,3}, {INIT,FINA,4}, {INIT,FINA,6}, },
 130
 131   /* State 3: prev was D/FINA, willing to join. */
 132   { {NONE,NONE,0}, {MEDI,FINA,1}, {MEDI,FINA,3}, {MEDI,FINA,4}, {MEDI,FINA,6}, },
 133
 134   /* State 4: prev was FINA ALAPH, not willing to join. */
 135   { {NONE,NONE,0}, {MED2,ISOL,1}, {MED2,ISOL,2}, {MED2,FIN2,5}, {MED2,ISOL,6}, },
 136
 137   /* State 5: prev was FIN2/FIN3 ALAPH, not willing to join. */
 138   { {NONE,NONE,0}, {ISOL,ISOL,1}, {ISOL,ISOL,2}, {ISOL,FIN2,5}, {ISOL,ISOL,6}, },
 139
 140   /* State 6: prev was DALATH/RISH, not willing to join. */
 141   { {NONE,NONE,0}, {NONE,ISOL,1}, {NONE,ISOL,2}, {NONE,FIN3,5}, {NONE,ISOL,6}, }
 142 };
 143
 144
 145
 146 void
 147 _hb_ot_shape_complex_collect_features_arabic    (hb_ot_shape_plan_t *plan, const hb_segment_properties_t  *props)
 148 {
 149   unsigned int num_features = props->script == HB_SCRIPT_SYRIAC ? SYRIAC_NUM_FEATURES : COMMON_NUM_FEATURES;
 150   for (unsigned int i = 0; i < num_features; i++)
 151     plan->map.add_bool_feature (arabic_syriac_features[i], false);
 152 }
 153
 154 void
 155 _hb_ot_shape_complex_setup_masks_arabic (hb_ot_shape_context_t *c)
 156 {
 157   unsigned int count = c->buffer->len;
 158   unsigned int prev = 0, state = 0;
 159
 160   for (unsigned int i = 0; i < count; i++)
 161   {
 162     unsigned int this_type = get_joining_type (c->buffer->info[i].codepoint, (hb_category_t) c->buffer->info[i].general_category());
 163
 164     if (unlikely (this_type == JOINING_TYPE_T)) {
 165       c->buffer->info[i].arabic_shaping_action() = NONE;
 166       continue;
 167     }
 168
 169     const arabic_state_table_entry *entry = &arabic_state_table[state][this_type];
 170
 171     if (entry->prev_action != NONE)
 172       c->buffer->info[prev].arabic_shaping_action() = entry->prev_action;
 173
 174     c->buffer->info[i].arabic_shaping_action() = entry->curr_action;
 175
 176     prev = i;
 177     state = entry->next_state;
 178   }
 179
 180   hb_mask_t mask_array[TOTAL_NUM_FEATURES + 1] = {0};
 181   unsigned int num_masks = c->buffer->props.script == HB_SCRIPT_SYRIAC ? SYRIAC_NUM_FEATURES : COMMON_NUM_FEATURES;
 182   for (unsigned int i = 0; i < num_masks; i++)
 183     mask_array[i] = c->plan->map.get_1_mask (arabic_syriac_features[i]);
 184
 185   for (unsigned int i = 0; i < count; i++)
 186     c->buffer->info[i].mask |= mask_array[c->buffer->info[i].arabic_shaping_action()];
 187 }
 188
 189
 190 HB_END_DECLS