src/hb-ot-layout.cc

   1 /*
   2  * Copyright © 1998-2004  David Turner and Werner Lemberg
   3  * Copyright © 2006  Behdad Esfahbod
   4  * Copyright © 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 #include "hb-ot-head-private.hh"
  37
  38
  39 #include <stdlib.h>
  40 #include <string.h>
  41
  42 HB_BEGIN_DECLS
  43
  44
  45 hb_ot_layout_t *
  46 _hb_ot_layout_create (hb_face_t *face)
  47 {
  48   /* Remove this object altogether */
  49   hb_ot_layout_t *layout = (hb_ot_layout_t *) calloc (1, sizeof (hb_ot_layout_t));
  50
  51   layout->gdef_blob = Sanitizer<GDEF>::sanitize (hb_face_reference_table (face, HB_OT_TAG_GDEF));
  52   layout->gdef = Sanitizer<GDEF>::lock_instance (layout->gdef_blob);
  53
  54   layout->gsub_blob = Sanitizer<GSUB>::sanitize (hb_face_reference_table (face, HB_OT_TAG_GSUB));
  55   layout->gsub = Sanitizer<GSUB>::lock_instance (layout->gsub_blob);
  56
  57   layout->gpos_blob = Sanitizer<GPOS>::sanitize (hb_face_reference_table (face, HB_OT_TAG_GPOS));
  58   layout->gpos = Sanitizer<GPOS>::lock_instance (layout->gpos_blob);
  59
  60   layout->head_blob = Sanitizer<head>::sanitize (hb_face_reference_table (face, HB_OT_TAG_head));
  61   layout->head = Sanitizer<head>::lock_instance (layout->head_blob);
  62
  63   return layout;
  64 }
  65
  66 void
  67 _hb_ot_layout_destroy (hb_ot_layout_t *layout)
  68 {
  69   hb_blob_unlock (layout->gdef_blob);
  70   hb_blob_unlock (layout->gsub_blob);
  71   hb_blob_unlock (layout->gpos_blob);
  72   hb_blob_unlock (layout->head_blob);
  73
  74   hb_blob_destroy (layout->gdef_blob);
  75   hb_blob_destroy (layout->gsub_blob);
  76   hb_blob_destroy (layout->gpos_blob);
  77   hb_blob_destroy (layout->head_blob);
  78
  79   free (layout);
  80 }
  81
  82 static inline const GDEF&
  83 _get_gdef (hb_face_t *face)
  84 {
  85   return likely (face->ot_layout && face->ot_layout->gdef) ? *face->ot_layout->gdef : Null(GDEF);
  86 }
  87 static inline const GSUB&
  88 _get_gsub (hb_face_t *face)
  89 {
  90   return likely (face->ot_layout && face->ot_layout->gsub) ? *face->ot_layout->gsub : Null(GSUB);
  91 }
  92 static inline const GPOS&
  93 _get_gpos (hb_face_t *face)
  94 {
  95   return likely (face->ot_layout && face->ot_layout->gpos) ? *face->ot_layout->gpos : Null(GPOS);
  96 }
  97 static inline const head&
  98 _get_head (hb_face_t *face)
  99 {
 100   return likely (face->ot_layout && face->ot_layout->head) ? *face->ot_layout->head : Null(head);
 101 }
 102
 103
 104 /*
 105  * GDEF
 106  */
 107
 108 hb_bool_t
 109 hb_ot_layout_has_glyph_classes (hb_face_t *face)
 110 {
 111   return _get_gdef (face).has_glyph_classes ();
 112 }
 113
 114 unsigned int
 115 _hb_ot_layout_get_glyph_property (hb_face_t       *face,
 116                                   hb_glyph_info_t *info)
 117 {
 118   if (!info->props_cache())
 119   {
 120     const GDEF &gdef = _get_gdef (face);
 121     info->props_cache() = gdef.get_glyph_props (info->codepoint);
 122   }
 123
 124   return info->props_cache();
 125 }
 126
 127 static hb_bool_t
 128 _hb_ot_layout_match_properties (hb_face_t      *face,
 129                                 hb_codepoint_t  codepoint,
 130                                 unsigned int    glyph_props,
 131                                 unsigned int    lookup_props)
 132 {
 133   /* Not covered, if, for example, glyph class is ligature and
 134    * lookup_props includes LookupFlags::IgnoreLigatures
 135    */
 136   if (glyph_props & lookup_props & LookupFlag::IgnoreFlags)
 137     return false;
 138
 139   if (glyph_props & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
 140   {
 141     /* If using mark filtering sets, the high short of
 142      * lookup_props has the set index.
 143      */
 144     if (lookup_props & LookupFlag::UseMarkFilteringSet)
 145       return _get_gdef (face).mark_set_covers (lookup_props >> 16, codepoint);
 146
 147     /* The second byte of lookup_props has the meaning
 148      * "ignore marks of attachment type different than
 149      * the attachment type specified."
 150      */
 151     if (lookup_props & LookupFlag::MarkAttachmentType && glyph_props & LookupFlag::MarkAttachmentType)
 152       return (lookup_props & LookupFlag::MarkAttachmentType) == (glyph_props & LookupFlag::MarkAttachmentType);
 153   }
 154
 155   return true;
 156 }
 157
 158 hb_bool_t
 159 _hb_ot_layout_check_glyph_property (hb_face_t    *face,
 160                                     hb_glyph_info_t *ginfo,
 161                                     unsigned int  lookup_props,
 162                                     unsigned int *property_out)
 163 {
 164   unsigned int property;
 165
 166   property = _hb_ot_layout_get_glyph_property (face, ginfo);
 167   (void) (property_out && (*property_out = property));
 168
 169   return _hb_ot_layout_match_properties (face, ginfo->codepoint, property, lookup_props);
 170 }
 171
 172 hb_bool_t
 173 _hb_ot_layout_skip_mark (hb_face_t    *face,
 174                          hb_glyph_info_t *ginfo,
 175                          unsigned int  lookup_props,
 176                          unsigned int *property_out)
 177 {
 178   unsigned int property;
 179
 180   property = _hb_ot_layout_get_glyph_property (face, ginfo);
 181   (void) (property_out && (*property_out = property));
 182
 183   /* If it's a mark, skip it we don't accept it. */
 184   if (unlikely (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK))
 185     return !_hb_ot_layout_match_properties (face, ginfo->codepoint, property, lookup_props);
 186
 187   /* If not a mark, don't skip. */
 188   return false;
 189 }
 190
 191
 192
 193 unsigned int
 194 hb_ot_layout_get_attach_points (hb_face_t      *face,
 195                                 hb_codepoint_t  glyph,
 196                                 unsigned int    start_offset,
 197                                 unsigned int   *point_count /* IN/OUT */,
 198                                 unsigned int   *point_array /* OUT */)
 199 {
 200   return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
 201 }
 202
 203 unsigned int
 204 hb_ot_layout_get_ligature_carets (hb_font_t      *font,
 205                                   hb_direction_t  direction,
 206                                   hb_codepoint_t  glyph,
 207                                   unsigned int    start_offset,
 208                                   unsigned int   *caret_count /* IN/OUT */,
 209                                   int            *caret_array /* OUT */)
 210 {
 211   hb_ot_layout_context_t c;
 212   c.font = font;
 213   c.face = font->face;
 214   return _get_gdef (c.face).get_lig_carets (&c, direction, glyph, start_offset, caret_count, caret_array);
 215 }
 216
 217 /*
 218  * GSUB/GPOS
 219  */
 220
 221 static const GSUBGPOS&
 222 get_gsubgpos_table (hb_face_t *face,
 223                     hb_tag_t   table_tag)
 224 {
 225   switch (table_tag) {
 226     case HB_OT_TAG_GSUB: return _get_gsub (face);
 227     case HB_OT_TAG_GPOS: return _get_gpos (face);
 228     default:             return Null(GSUBGPOS);
 229   }
 230 }
 231
 232
 233 unsigned int
 234 hb_ot_layout_table_get_script_tags (hb_face_t    *face,
 235                                     hb_tag_t      table_tag,
 236                                     unsigned int  start_offset,
 237                                     unsigned int *script_count /* IN/OUT */,
 238                                     hb_tag_t     *script_tags /* OUT */)
 239 {
 240   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 241
 242   return g.get_script_tags (start_offset, script_count, script_tags);
 243 }
 244
 245 hb_bool_t
 246 hb_ot_layout_table_find_script (hb_face_t    *face,
 247                                 hb_tag_t      table_tag,
 248                                 hb_tag_t      script_tag,
 249                                 unsigned int *script_index)
 250 {
 251   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
 252   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 253
 254   if (g.find_script_index (script_tag, script_index))
 255     return TRUE;
 256
 257   /* try finding 'DFLT' */
 258   if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
 259     return FALSE;
 260
 261   /* try with 'dflt'; MS site has had typos and many fonts use it now :(.
 262    * including many versions of DejaVu Sans Mono! */
 263   if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
 264     return FALSE;
 265
 266   if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
 267   return FALSE;
 268 }
 269
 270 hb_bool_t
 271 hb_ot_layout_table_choose_script (hb_face_t      *face,
 272                                   hb_tag_t        table_tag,
 273                                   const hb_tag_t *script_tags,
 274                                   unsigned int   *script_index)
 275 {
 276   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
 277   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 278
 279   while (*script_tags)
 280   {
 281     if (g.find_script_index (*script_tags, script_index))
 282       return TRUE;
 283     script_tags++;
 284   }
 285
 286   /* try finding 'DFLT' */
 287   if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
 288     return FALSE;
 289
 290   /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
 291   if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
 292     return FALSE;
 293
 294   if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
 295   return FALSE;
 296 }
 297
 298 unsigned int
 299 hb_ot_layout_table_get_feature_tags (hb_face_t    *face,
 300                                      hb_tag_t      table_tag,
 301                                      unsigned int  start_offset,
 302                                      unsigned int *feature_count /* IN/OUT */,
 303                                      hb_tag_t     *feature_tags /* OUT */)
 304 {
 305   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 306
 307   return g.get_feature_tags (start_offset, feature_count, feature_tags);
 308 }
 309
 310
 311 unsigned int
 312 hb_ot_layout_script_get_language_tags (hb_face_t    *face,
 313                                        hb_tag_t      table_tag,
 314                                        unsigned int  script_index,
 315                                        unsigned int  start_offset,
 316                                        unsigned int *language_count /* IN/OUT */,
 317                                        hb_tag_t     *language_tags /* OUT */)
 318 {
 319   const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
 320
 321   return s.get_lang_sys_tags (start_offset, language_count, language_tags);
 322 }
 323
 324 hb_bool_t
 325 hb_ot_layout_script_find_language (hb_face_t    *face,
 326                                    hb_tag_t      table_tag,
 327                                    unsigned int  script_index,
 328                                    hb_tag_t      language_tag,
 329                                    unsigned int *language_index)
 330 {
 331   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
 332   const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
 333
 334   if (s.find_lang_sys_index (language_tag, language_index))
 335     return TRUE;
 336
 337   /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
 338   if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
 339     return FALSE;
 340
 341   if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
 342   return FALSE;
 343 }
 344
 345 hb_bool_t
 346 hb_ot_layout_language_get_required_feature_index (hb_face_t    *face,
 347                                                   hb_tag_t      table_tag,
 348                                                   unsigned int  script_index,
 349                                                   unsigned int  language_index,
 350                                                   unsigned int *feature_index)
 351 {
 352   const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
 353
 354   if (feature_index) *feature_index = l.get_required_feature_index ();
 355
 356   return l.has_required_feature ();
 357 }
 358
 359 unsigned int
 360 hb_ot_layout_language_get_feature_indexes (hb_face_t    *face,
 361                                            hb_tag_t      table_tag,
 362                                            unsigned int  script_index,
 363                                            unsigned int  language_index,
 364                                            unsigned int  start_offset,
 365                                            unsigned int *feature_count /* IN/OUT */,
 366                                            unsigned int *feature_indexes /* OUT */)
 367 {
 368   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 369   const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
 370
 371   return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
 372 }
 373
 374 unsigned int
 375 hb_ot_layout_language_get_feature_tags (hb_face_t    *face,
 376                                         hb_tag_t      table_tag,
 377                                         unsigned int  script_index,
 378                                         unsigned int  language_index,
 379                                         unsigned int  start_offset,
 380                                         unsigned int *feature_count /* IN/OUT */,
 381                                         hb_tag_t     *feature_tags /* OUT */)
 382 {
 383   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 384   const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
 385
 386   ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
 387   unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
 388
 389   if (feature_tags) {
 390     unsigned int count = *feature_count;
 391     for (unsigned int i = 0; i < count; i++)
 392       feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
 393   }
 394
 395   return ret;
 396 }
 397
 398
 399 hb_bool_t
 400 hb_ot_layout_language_find_feature (hb_face_t    *face,
 401                                     hb_tag_t      table_tag,
 402                                     unsigned int  script_index,
 403                                     unsigned int  language_index,
 404                                     hb_tag_t      feature_tag,
 405                                     unsigned int *feature_index)
 406 {
 407   ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
 408   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 409   const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
 410
 411   unsigned int num_features = l.get_feature_count ();
 412   for (unsigned int i = 0; i < num_features; i++) {
 413     unsigned int f_index = l.get_feature_index (i);
 414
 415     if (feature_tag == g.get_feature_tag (f_index)) {
 416       if (feature_index) *feature_index = f_index;
 417       return TRUE;
 418     }
 419   }
 420
 421   if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
 422   return FALSE;
 423 }
 424
 425 unsigned int
 426 hb_ot_layout_feature_get_lookup_indexes (hb_face_t    *face,
 427                                          hb_tag_t      table_tag,
 428                                          unsigned int  feature_index,
 429                                          unsigned int  start_offset,
 430                                          unsigned int *lookup_count /* IN/OUT */,
 431                                          unsigned int *lookup_indexes /* OUT */)
 432 {
 433   const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
 434   const Feature &f = g.get_feature (feature_index);
 435
 436   return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
 437 }
 438
 439
 440 /*
 441  * GSUB
 442  */
 443
 444 hb_bool_t
 445 hb_ot_layout_has_substitution (hb_face_t *face)
 446 {
 447   return &_get_gsub (face) != &Null(GSUB);
 448 }
 449
 450 hb_bool_t
 451 hb_ot_layout_substitute_lookup (hb_face_t    *face,
 452                                 hb_buffer_t  *buffer,
 453                                 unsigned int  lookup_index,
 454                                 hb_mask_t     mask)
 455 {
 456   hb_ot_layout_context_t c;
 457   c.font = NULL;
 458   c.face = face;
 459   return _get_gsub (face).substitute_lookup (&c, buffer, lookup_index, mask);
 460 }
 461
 462
 463 /*
 464  * GPOS
 465  */
 466
 467 hb_bool_t
 468 hb_ot_layout_has_positioning (hb_face_t *face)
 469 {
 470   return &_get_gpos (face) != &Null(GPOS);
 471 }
 472
 473 void
 474 hb_ot_layout_position_start (hb_buffer_t  *buffer)
 475 {
 476   buffer->clear_positions ();
 477 }
 478
 479 hb_bool_t
 480 hb_ot_layout_position_lookup   (hb_font_t    *font,
 481                                 hb_buffer_t  *buffer,
 482                                 unsigned int  lookup_index,
 483                                 hb_mask_t     mask)
 484 {
 485   hb_ot_layout_context_t c;
 486   c.font = font;
 487   c.face = font->face;
 488   return _get_gpos (c.face).position_lookup (&c, buffer, lookup_index, mask);
 489 }
 490
 491 void
 492 hb_ot_layout_position_finish (hb_buffer_t  *buffer)
 493 {
 494   GPOS::position_finish (buffer);
 495 }
 496
 497
 498 /*
 499  * head
 500  */
 501
 502 unsigned int
 503 _hb_ot_layout_get_upem (hb_face_t *face)
 504 {
 505   return _get_head (face).get_upem ();
 506 }
 507
 508
 509 HB_END_DECLS