src/hb-ot-layout.cc

   1 /*
   2  * Copyright (C) 1998-2004  David Turner and Werner Lemberg
   3  * Copyright (C) 2006  Behdad Esfahbod
   4  * Copyright (C) 2007,2008,2009  Red Hat, Inc.
   5  *
   6  *  This is part of HarfBuzz, a text shaping library.
   7  *
   8  * Permission is hereby granted, without written agreement and without
   9  * license or royalty fees, to use, copy, modify, and distribute this
  10  * software and its documentation for any purpose, provided that the
  11  * above copyright notice and the following two paragraphs appear in
  12  * all copies of this software.
  13  *
  14  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  15  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  16  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  17  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  18  * DAMAGE.
  19  *
  20  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  21  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  22  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  23  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  24  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  25  *
  26  * Red Hat Author(s): Behdad Esfahbod
  27  */
  28
  29 #define HB_OT_LAYOUT_CC
  30
  31 #include "hb-ot-layout-private.hh"
  32
  33 #include "hb-ot-layout-gdef-private.hh"
  34 #include "hb-ot-layout-gsub-private.hh"
  35 #include "hb-ot-layout-gpos-private.hh"
  36
  37
  38 #include <stdlib.h>
  39 #include <string.h>
  40
  41 HB_BEGIN_DECLS
  42
  43
  44 hb_ot_layout_t *
  45 _hb_ot_layout_new (hb_face_t *face)
  46 {
  47   /* Remove this object altogether */
  48   hb_ot_layout_t *layout = (hb_ot_layout_t *) calloc (1, sizeof (hb_ot_layout_t));
  49
  50   layout->gdef_blob = Sanitizer<GDEF>::sanitize (hb_face_get_table (face, HB_OT_TAG_GDEF));
  51   layout->gdef = Sanitizer<GDEF>::lock_instance (layout->gdef_blob);
  52
  53   layout->gsub_blob = Sanitizer<GSUB>::sanitize (hb_face_get_table (face, HB_OT_TAG_GSUB));
  54   layout->gsub = Sanitizer<GSUB>::lock_instance (layout->gsub_blob);
  55
  56   layout->gpos_blob = Sanitizer<GPOS>::sanitize (hb_face_get_table (face, HB_OT_TAG_GPOS));
  57   layout->gpos = Sanitizer<GPOS>::lock_instance (layout->gpos_blob);
  58
  59   return layout;
  60 }
  61
  62 void
  63 _hb_ot_layout_free (hb_ot_layout_t *layout)
  64 {
  65   hb_blob_unlock (layout->gdef_blob);
  66   hb_blob_unlock (layout->gsub_blob);
  67   hb_blob_unlock (layout->gpos_blob);
  68
  69   hb_blob_destroy (layout->gdef_blob);
  70   hb_blob_destroy (layout->gsub_blob);
  71   hb_blob_destroy (layout->gpos_blob);
  72
  73   free (layout);
  74 }
  75
  76 static inline const GDEF&
  77 _get_gdef (hb_face_t *face)
  78 {
  79   return likely (face->ot_layout && face->ot_layout->gdef) ? *face->ot_layout->gdef : Null(GDEF);
  80 }
  81
  82 static inline const GSUB&
  83 _get_gsub (hb_face_t *face)
  84 {
  85   return likely (face->ot_layout && face->ot_layout->gsub) ? *face->ot_layout->gsub : Null(GSUB);
  86 }
  87
  88 static inline const GPOS&
  89 _get_gpos (hb_face_t *face)
  90 {
  91   return likely (face->ot_layout && face->ot_layout->gpos) ? *face->ot_layout->gpos : Null(GPOS);
  92 }
  93
  94
  95 /*
  96  * GDEF
  97  */
  98
  99 hb_bool_t
 100 hb_ot_layout_has_glyph_classes (hb_face_t *face)
 101 {
 102   return _get_gdef (face).has_glyph_classes ();
 103 }
 104
 105 unsigned int
 106 _hb_ot_layout_get_glyph_property (hb_face_t       *face,
 107                                   hb_glyph_info_t *info)
 108 {
 109   if (!info->gproperty())
 110   {
 111     const GDEF &gdef = _get_gdef (face);
 112     info->gproperty() = gdef.get_glyph_props (info->codepoint);
 113   }
 114
 115   return info->gproperty();
 116 }
 117
 118 hb_bool_t
 119 _hb_ot_layout_check_glyph_property (hb_face_t    *face,
 120                                     hb_glyph_info_t *ginfo,
 121                                     unsigned int  lookup_props,
 122                                     unsigned int *property_out)
 123 {
 124   unsigned int property;
 125
 126   property = _hb_ot_layout_get_glyph_property (face, ginfo);
 127   if (property_out)
 128     *property_out = property;
 129
 130   /* Not covered, if, for example, glyph class is ligature and
 131    * lookup_props includes LookupFlags::IgnoreLigatures
 132    */
 133   if (property & lookup_props & LookupFlag::IgnoreFlags)
 134     return false;
 135
 136   if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
 137   {
 138     /* If using mark filtering sets, the high short of
 139      * lookup_props has the set index.
 140      */
 141     if (lookup_props & LookupFlag::UseMarkFilteringSet)
 142       return _get_gdef (face).mark_set_covers (lookup_props >> 16, ginfo->codepoint);
 143
 144     /* The second byte of lookup_props has the meaning
 145      * "ignore marks of attachment type different than
 146      * the attachment type specified."
 147      */
 148     if (lookup_props & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
 149       return (lookup_props & LookupFlag::MarkAttachmentType) == (property & LookupFlag::MarkAttachmentType);
 150   }
 151
 152   return true;
 153 }
 154
 155 unsigned int
 156 hb_ot_layout_get_attach_points (hb_face_t      *face,
 157                                 hb_codepoint_t  glyph,
 158                                 unsigned int    start_offset,
 159                                 unsigned int   *point_count /* IN/OUT */,
 160                                 unsigned int   *point_array /* OUT */)
 161 {
 162   return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
 163 }
 164
 165 unsigned int
 166 hb_ot_layout_get_ligature_carets (hb_font_t      *font,
 167                                   hb_face_t      *face,
 168                                   hb_direction_t  direction,
 169                                   hb_codepoint_t  glyph,
 170                                   unsigned int    start_offset,
 171                                   unsigned int   *caret_count /* IN/OUT */,
 172                                   int            *caret_array /* OUT */)
 173 {
 174   hb_ot_layout_context_t c;
 175   c.font = font;
 176   c.face = face;
 177   return _get_gdef (face).get_lig_carets (&c, direction, glyph, start_offset, caret_count, caret_array);
 178 }
 179
 180 /*
 181  * GSUB/GPOS
 182  */
 183
 184 static const GSUBGPOS&
 185 get_gsubgpos_table (hb_face_t *face,
 186                     hb_tag_t   table_tag)
 187 {
 188   switch (table_tag) {
 189     case HB_OT_TAG_GSUB: return _get_gsub (face);
 190     case HB_OT_TAG_GPOS: return _get_gpos (face);
 191     default:             return Null(GSUBGPOS);
 192   }
 193 }
 194
 195
 196 unsigned int
 197 hb_ot_layout_table_get_script_tags (hb_face_t    *face,
 198                                     hb_tag_t      table_tag,
 199                                     unsigned int  start_offset,
 200                                     unsigned int *script_count /* IN/OUT */,
 201                                     hb_tag_t     *script_tags /* OUT */)
 202 {
 203   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 204
 205   return g.get_script_tags (start_offset, script_count, script_tags);
 206 }
 207
 208 hb_bool_t
 209 hb_ot_layout_table_find_script (hb_face_t    *face,
 210                                 hb_tag_t      table_tag,
 211                                 hb_tag_t      script_tag,
 212                                 unsigned int *script_index)
 213 {
 214   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
 215   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 216
 217   if (g.find_script_index (script_tag, script_index))
 218     return TRUE;
 219
 220   /* try finding 'DFLT' */
 221   if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
 222     return FALSE;
 223
 224   /* try with 'dflt'; MS site has had typos and many fonts use it now :(.
 225    * including many versions of DejaVu Sans Mono! */
 226   if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
 227     return FALSE;
 228
 229   if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
 230   return FALSE;
 231 }
 232
 233 hb_bool_t
 234 hb_ot_layout_table_choose_script (hb_face_t      *face,
 235                                   hb_tag_t        table_tag,
 236                                   const hb_tag_t *script_tags,
 237                                   unsigned int   *script_index)
 238 {
 239   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
 240   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 241
 242   while (*script_tags)
 243   {
 244     if (g.find_script_index (*script_tags, script_index))
 245       return TRUE;
 246     script_tags++;
 247   }
 248
 249   /* try finding 'DFLT' */
 250   if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
 251     return FALSE;
 252
 253   /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
 254   if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
 255     return FALSE;
 256
 257   if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
 258   return FALSE;
 259 }
 260
 261 unsigned int
 262 hb_ot_layout_table_get_feature_tags (hb_face_t    *face,
 263                                      hb_tag_t      table_tag,
 264                                      unsigned int  start_offset,
 265                                      unsigned int *feature_count /* IN/OUT */,
 266                                      hb_tag_t     *feature_tags /* OUT */)
 267 {
 268   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 269
 270   return g.get_feature_tags (start_offset, feature_count, feature_tags);
 271 }
 272
 273
 274 unsigned int
 275 hb_ot_layout_script_get_language_tags (hb_face_t    *face,
 276                                        hb_tag_t      table_tag,
 277                                        unsigned int  script_index,
 278                                        unsigned int  start_offset,
 279                                        unsigned int *language_count /* IN/OUT */,
 280                                        hb_tag_t     *language_tags /* OUT */)
 281 {
 282   const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
 283
 284   return s.get_lang_sys_tags (start_offset, language_count, language_tags);
 285 }
 286
 287 hb_bool_t
 288 hb_ot_layout_script_find_language (hb_face_t    *face,
 289                                    hb_tag_t      table_tag,
 290                                    unsigned int  script_index,
 291                                    hb_tag_t      language_tag,
 292                                    unsigned int *language_index)
 293 {
 294   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
 295   const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
 296
 297   if (s.find_lang_sys_index (language_tag, language_index))
 298     return TRUE;
 299
 300   /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
 301   if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
 302     return FALSE;
 303
 304   if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
 305   return FALSE;
 306 }
 307
 308 hb_bool_t
 309 hb_ot_layout_language_get_required_feature_index (hb_face_t    *face,
 310                                                   hb_tag_t      table_tag,
 311                                                   unsigned int  script_index,
 312                                                   unsigned int  language_index,
 313                                                   unsigned int *feature_index)
 314 {
 315   const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
 316
 317   if (feature_index) *feature_index = l.get_required_feature_index ();
 318
 319   return l.has_required_feature ();
 320 }
 321
 322 unsigned int
 323 hb_ot_layout_language_get_feature_indexes (hb_face_t    *face,
 324                                            hb_tag_t      table_tag,
 325                                            unsigned int  script_index,
 326                                            unsigned int  language_index,
 327                                            unsigned int  start_offset,
 328                                            unsigned int *feature_count /* IN/OUT */,
 329                                            unsigned int *feature_indexes /* OUT */)
 330 {
 331   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 332   const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
 333
 334   return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
 335 }
 336
 337 unsigned int
 338 hb_ot_layout_language_get_feature_tags (hb_face_t    *face,
 339                                         hb_tag_t      table_tag,
 340                                         unsigned int  script_index,
 341                                         unsigned int  language_index,
 342                                         unsigned int  start_offset,
 343                                         unsigned int *feature_count /* IN/OUT */,
 344                                         hb_tag_t     *feature_tags /* OUT */)
 345 {
 346   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 347   const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
 348
 349   ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
 350   unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
 351
 352   if (feature_tags) {
 353     unsigned int count = *feature_count;
 354     for (unsigned int i = 0; i < count; i++)
 355       feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
 356   }
 357
 358   return ret;
 359 }
 360
 361
 362 hb_bool_t
 363 hb_ot_layout_language_find_feature (hb_face_t    *face,
 364                                     hb_tag_t      table_tag,
 365                                     unsigned int  script_index,
 366                                     unsigned int  language_index,
 367                                     hb_tag_t      feature_tag,
 368                                     unsigned int *feature_index)
 369 {
 370   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
 371   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 372   const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
 373
 374   unsigned int num_features = l.get_feature_count ();
 375   for (unsigned int i = 0; i < num_features; i++) {
 376     unsigned int f_index = l.get_feature_index (i);
 377
 378     if (feature_tag == g.get_feature_tag (f_index)) {
 379       if (feature_index) *feature_index = f_index;
 380       return TRUE;
 381     }
 382   }
 383
 384   if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
 385   return FALSE;
 386 }
 387
 388 unsigned int
 389 hb_ot_layout_feature_get_lookup_indexes (hb_face_t    *face,
 390                                          hb_tag_t      table_tag,
 391                                          unsigned int  feature_index,
 392                                          unsigned int  start_offset,
 393                                          unsigned int *lookup_count /* IN/OUT */,
 394                                          unsigned int *lookup_indexes /* OUT */)
 395 {
 396   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 397   const Feature &f = g.get_feature (feature_index);
 398
 399   return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
 400 }
 401
 402
 403 /*
 404  * GSUB
 405  */
 406
 407 hb_bool_t
 408 hb_ot_layout_has_substitution (hb_face_t *face)
 409 {
 410   return &_get_gsub (face) != &Null(GSUB);
 411 }
 412
 413 hb_bool_t
 414 hb_ot_layout_substitute_lookup (hb_face_t    *face,
 415                                 hb_buffer_t  *buffer,
 416                                 unsigned int  lookup_index,
 417                                 hb_mask_t     mask)
 418 {
 419   hb_ot_layout_context_t c;
 420   c.font = NULL;
 421   c.face = face;
 422   return _get_gsub (face).substitute_lookup (&c, buffer, lookup_index, mask);
 423 }
 424
 425
 426 /*
 427  * GPOS
 428  */
 429
 430 hb_bool_t
 431 hb_ot_layout_has_positioning (hb_face_t *face)
 432 {
 433   return &_get_gpos (face) != &Null(GPOS);
 434 }
 435
 436 hb_bool_t
 437 hb_ot_layout_position_lookup   (hb_font_t    *font,
 438                                 hb_face_t    *face,
 439                                 hb_buffer_t  *buffer,
 440                                 unsigned int  lookup_index,
 441                                 hb_mask_t     mask)
 442 {
 443   hb_ot_layout_context_t c;
 444   c.font = font;
 445   c.face = face;
 446   return _get_gpos (face).position_lookup (&c, buffer, lookup_index, mask);
 447 }
 448
 449 void
 450 hb_ot_layout_position_finish (hb_buffer_t  *buffer)
 451 {
 452   GPOS::position_finish (buffer);
 453 }
 454
 455
 456 HB_END_DECLS