third_party/harfbuzz-ng/src/hb-font.cc

   1 /*
   2  * Copyright © 2009  Red Hat, Inc.
   3  * Copyright © 2012  Google, Inc.
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #include "hb-private.hh"
  30
  31 #include "hb-ot-layout-private.hh"
  32
  33 #include "hb-font-private.hh"
  34 #include "hb-open-file-private.hh"
  35 #include "hb-ot-head-table.hh"
  36 #include "hb-ot-maxp-table.hh"
  37
  38 #include "hb-cache-private.hh"
  39
  40 #include <string.h>
  41
  42
  43 /*
  44  * hb_font_funcs_t
  45  */
  46
  47 static hb_bool_t
  48 hb_font_get_glyph_nil (hb_font_t *font,
  49                        void *font_data HB_UNUSED,
  50                        hb_codepoint_t unicode,
  51                        hb_codepoint_t variation_selector,
  52                        hb_codepoint_t *glyph,
  53                        void *user_data HB_UNUSED)
  54 {
  55   if (font->parent)
  56     return font->parent->get_glyph (unicode, variation_selector, glyph);
  57
  58   *glyph = 0;
  59   return false;
  60 }
  61
  62 static hb_position_t
  63 hb_font_get_glyph_h_advance_nil (hb_font_t *font,
  64                                  void *font_data HB_UNUSED,
  65                                  hb_codepoint_t glyph,
  66                                  void *user_data HB_UNUSED)
  67 {
  68   if (font->parent)
  69     return font->parent_scale_x_distance (font->parent->get_glyph_h_advance (glyph));
  70
  71   return font->x_scale;
  72 }
  73
  74 static hb_position_t
  75 hb_font_get_glyph_v_advance_nil (hb_font_t *font,
  76                                  void *font_data HB_UNUSED,
  77                                  hb_codepoint_t glyph,
  78                                  void *user_data HB_UNUSED)
  79 {
  80   if (font->parent)
  81     return font->parent_scale_y_distance (font->parent->get_glyph_v_advance (glyph));
  82
  83   return font->y_scale;
  84 }
  85
  86 static hb_bool_t
  87 hb_font_get_glyph_h_origin_nil (hb_font_t *font,
  88                                 void *font_data HB_UNUSED,
  89                                 hb_codepoint_t glyph,
  90                                 hb_position_t *x,
  91                                 hb_position_t *y,
  92                                 void *user_data HB_UNUSED)
  93 {
  94   if (font->parent) {
  95     hb_bool_t ret = font->parent->get_glyph_h_origin (glyph, x, y);
  96     if (ret)
  97       font->parent_scale_position (x, y);
  98     return ret;
  99   }
 100
 101   *x = *y = 0;
 102   return false;
 103 }
 104
 105 static hb_bool_t
 106 hb_font_get_glyph_v_origin_nil (hb_font_t *font,
 107                                 void *font_data HB_UNUSED,
 108                                 hb_codepoint_t glyph,
 109                                 hb_position_t *x,
 110                                 hb_position_t *y,
 111                                 void *user_data HB_UNUSED)
 112 {
 113   if (font->parent) {
 114     hb_bool_t ret = font->parent->get_glyph_v_origin (glyph, x, y);
 115     if (ret)
 116       font->parent_scale_position (x, y);
 117     return ret;
 118   }
 119
 120   *x = *y = 0;
 121   return false;
 122 }
 123
 124 static hb_position_t
 125 hb_font_get_glyph_h_kerning_nil (hb_font_t *font,
 126                                  void *font_data HB_UNUSED,
 127                                  hb_codepoint_t left_glyph,
 128                                  hb_codepoint_t right_glyph,
 129                                  void *user_data HB_UNUSED)
 130 {
 131   if (font->parent)
 132     return font->parent_scale_x_distance (font->parent->get_glyph_h_kerning (left_glyph, right_glyph));
 133
 134   return 0;
 135 }
 136
 137 static hb_position_t
 138 hb_font_get_glyph_v_kerning_nil (hb_font_t *font,
 139                                  void *font_data HB_UNUSED,
 140                                  hb_codepoint_t top_glyph,
 141                                  hb_codepoint_t bottom_glyph,
 142                                  void *user_data HB_UNUSED)
 143 {
 144   if (font->parent)
 145     return font->parent_scale_y_distance (font->parent->get_glyph_v_kerning (top_glyph, bottom_glyph));
 146
 147   return 0;
 148 }
 149
 150 static hb_bool_t
 151 hb_font_get_glyph_extents_nil (hb_font_t *font,
 152                                void *font_data HB_UNUSED,
 153                                hb_codepoint_t glyph,
 154                                hb_glyph_extents_t *extents,
 155                                void *user_data HB_UNUSED)
 156 {
 157   if (font->parent) {
 158     hb_bool_t ret = font->parent->get_glyph_extents (glyph, extents);
 159     if (ret) {
 160       font->parent_scale_position (&extents->x_bearing, &extents->y_bearing);
 161       font->parent_scale_distance (&extents->width, &extents->height);
 162     }
 163     return ret;
 164   }
 165
 166   memset (extents, 0, sizeof (*extents));
 167   return false;
 168 }
 169
 170 static hb_bool_t
 171 hb_font_get_glyph_contour_point_nil (hb_font_t *font,
 172                                      void *font_data HB_UNUSED,
 173                                      hb_codepoint_t glyph,
 174                                      unsigned int point_index,
 175                                      hb_position_t *x,
 176                                      hb_position_t *y,
 177                                      void *user_data HB_UNUSED)
 178 {
 179   if (font->parent) {
 180     hb_bool_t ret = font->parent->get_glyph_contour_point (glyph, point_index, x, y);
 181     if (ret)
 182       font->parent_scale_position (x, y);
 183     return ret;
 184   }
 185
 186   *x = *y = 0;
 187   return false;
 188 }
 189
 190 static hb_bool_t
 191 hb_font_get_glyph_name_nil (hb_font_t *font,
 192                             void *font_data HB_UNUSED,
 193                             hb_codepoint_t glyph,
 194                             char *name, unsigned int size,
 195                             void *user_data HB_UNUSED)
 196 {
 197   if (font->parent)
 198     return font->parent->get_glyph_name (glyph, name, size);
 199
 200   if (size) *name = '\0';
 201   return false;
 202 }
 203
 204 static hb_bool_t
 205 hb_font_get_glyph_from_name_nil (hb_font_t *font,
 206                                  void *font_data HB_UNUSED,
 207                                  const char *name, int len, /* -1 means nul-terminated */
 208                                  hb_codepoint_t *glyph,
 209                                  void *user_data HB_UNUSED)
 210 {
 211   if (font->parent)
 212     return font->parent->get_glyph_from_name (name, len, glyph);
 213
 214   *glyph = 0;
 215   return false;
 216 }
 217
 218
 219 static const hb_font_funcs_t _hb_font_funcs_nil = {
 220   HB_OBJECT_HEADER_STATIC,
 221
 222   true, /* immutable */
 223
 224   {
 225 #define HB_FONT_FUNC_IMPLEMENT(name) hb_font_get_##name##_nil,
 226     HB_FONT_FUNCS_IMPLEMENT_CALLBACKS
 227 #undef HB_FONT_FUNC_IMPLEMENT
 228   }
 229 };
 230
 231
 232 /**
 233  * hb_font_funcs_create: (Xconstructor)
 234  *
 235  *
 236  *
 237  * Return value: (transfer full):
 238  *
 239  * Since: 1.0
 240  **/
 241 hb_font_funcs_t *
 242 hb_font_funcs_create (void)
 243 {
 244   hb_font_funcs_t *ffuncs;
 245
 246   if (!(ffuncs = hb_object_create<hb_font_funcs_t> ()))
 247     return hb_font_funcs_get_empty ();
 248
 249   ffuncs->get = _hb_font_funcs_nil.get;
 250
 251   return ffuncs;
 252 }
 253
 254 /**
 255  * hb_font_funcs_get_empty:
 256  *
 257  *
 258  *
 259  * Return value: (transfer full):
 260  *
 261  * Since: 1.0
 262  **/
 263 hb_font_funcs_t *
 264 hb_font_funcs_get_empty (void)
 265 {
 266   return const_cast<hb_font_funcs_t *> (&_hb_font_funcs_nil);
 267 }
 268
 269 /**
 270  * hb_font_funcs_reference: (skip)
 271  * @ffuncs: font functions.
 272  *
 273  *
 274  *
 275  * Return value:
 276  *
 277  * Since: 1.0
 278  **/
 279 hb_font_funcs_t *
 280 hb_font_funcs_reference (hb_font_funcs_t *ffuncs)
 281 {
 282   return hb_object_reference (ffuncs);
 283 }
 284
 285 /**
 286  * hb_font_funcs_destroy: (skip)
 287  * @ffuncs: font functions.
 288  *
 289  *
 290  *
 291  * Since: 1.0
 292  **/
 293 void
 294 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs)
 295 {
 296   if (!hb_object_destroy (ffuncs)) return;
 297
 298 #define HB_FONT_FUNC_IMPLEMENT(name) if (ffuncs->destroy.name) \
 299   ffuncs->destroy.name (ffuncs->user_data.name);
 300   HB_FONT_FUNCS_IMPLEMENT_CALLBACKS
 301 #undef HB_FONT_FUNC_IMPLEMENT
 302
 303   free (ffuncs);
 304 }
 305
 306 /**
 307  * hb_font_funcs_set_user_data: (skip)
 308  * @ffuncs: font functions.
 309  * @key:
 310  * @data:
 311  * @destroy:
 312  * @replace:
 313  *
 314  *
 315  *
 316  * Return value:
 317  *
 318  * Since: 1.0
 319  **/
 320 hb_bool_t
 321 hb_font_funcs_set_user_data (hb_font_funcs_t    *ffuncs,
 322                              hb_user_data_key_t *key,
 323                              void *              data,
 324                              hb_destroy_func_t   destroy,
 325                              hb_bool_t           replace)
 326 {
 327   return hb_object_set_user_data (ffuncs, key, data, destroy, replace);
 328 }
 329
 330 /**
 331  * hb_font_funcs_get_user_data: (skip)
 332  * @ffuncs: font functions.
 333  * @key:
 334  *
 335  *
 336  *
 337  * Return value: (transfer none):
 338  *
 339  * Since: 1.0
 340  **/
 341 void *
 342 hb_font_funcs_get_user_data (hb_font_funcs_t    *ffuncs,
 343                              hb_user_data_key_t *key)
 344 {
 345   return hb_object_get_user_data (ffuncs, key);
 346 }
 347
 348
 349 /**
 350  * hb_font_funcs_make_immutable:
 351  * @ffuncs: font functions.
 352  *
 353  *
 354  *
 355  * Since: 1.0
 356  **/
 357 void
 358 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs)
 359 {
 360   if (unlikely (hb_object_is_inert (ffuncs)))
 361     return;
 362
 363   ffuncs->immutable = true;
 364 }
 365
 366 /**
 367  * hb_font_funcs_is_immutable:
 368  * @ffuncs: font functions.
 369  *
 370  *
 371  *
 372  * Return value:
 373  *
 374  * Since: 1.0
 375  **/
 376 hb_bool_t
 377 hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs)
 378 {
 379   return ffuncs->immutable;
 380 }
 381
 382
 383 #define HB_FONT_FUNC_IMPLEMENT(name) \
 384                                                                          \
 385 void                                                                     \
 386 hb_font_funcs_set_##name##_func (hb_font_funcs_t             *ffuncs,    \
 387                                  hb_font_get_##name##_func_t  func,      \
 388                                  void                        *user_data, \
 389                                  hb_destroy_func_t            destroy)   \
 390 {                                                                        \
 391   if (ffuncs->immutable) {                                               \
 392     if (destroy)                                                         \
 393       destroy (user_data);                                               \
 394     return;                                                              \
 395   }                                                                      \
 396                                                                          \
 397   if (ffuncs->destroy.name)                                              \
 398     ffuncs->destroy.name (ffuncs->user_data.name);                       \
 399                                                                          \
 400   if (func) {                                                            \
 401     ffuncs->get.name = func;                                             \
 402     ffuncs->user_data.name = user_data;                                  \
 403     ffuncs->destroy.name = destroy;                                      \
 404   } else {                                                               \
 405     ffuncs->get.name = hb_font_get_##name##_nil;                         \
 406     ffuncs->user_data.name = NULL;                                       \
 407     ffuncs->destroy.name = NULL;                                         \
 408   }                                                                      \
 409 }
 410
 411 HB_FONT_FUNCS_IMPLEMENT_CALLBACKS
 412 #undef HB_FONT_FUNC_IMPLEMENT
 413
 414
 415 /* Public getters */
 416
 417 /**
 418  * hb_font_get_glyph:
 419  * @font: a font.
 420  * @unicode:
 421  * @variation_selector:
 422  * @glyph: (out):
 423  *
 424  *
 425  *
 426  * Return value:
 427  *
 428  * Since: 1.0
 429  **/
 430 hb_bool_t
 431 hb_font_get_glyph (hb_font_t *font,
 432                    hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 433                    hb_codepoint_t *glyph)
 434 {
 435   return font->get_glyph (unicode, variation_selector, glyph);
 436 }
 437
 438 /**
 439  * hb_font_get_glyph_h_advance:
 440  * @font: a font.
 441  * @glyph:
 442  *
 443  *
 444  *
 445  * Return value:
 446  *
 447  * Since: 1.0
 448  **/
 449 hb_position_t
 450 hb_font_get_glyph_h_advance (hb_font_t *font,
 451                              hb_codepoint_t glyph)
 452 {
 453   return font->get_glyph_h_advance (glyph);
 454 }
 455
 456 /**
 457  * hb_font_get_glyph_v_advance:
 458  * @font: a font.
 459  * @glyph:
 460  *
 461  *
 462  *
 463  * Return value:
 464  *
 465  * Since: 1.0
 466  **/
 467 hb_position_t
 468 hb_font_get_glyph_v_advance (hb_font_t *font,
 469                              hb_codepoint_t glyph)
 470 {
 471   return font->get_glyph_v_advance (glyph);
 472 }
 473
 474 /**
 475  * hb_font_get_glyph_h_origin:
 476  * @font: a font.
 477  * @glyph:
 478  * @x: (out):
 479  * @y: (out):
 480  *
 481  *
 482  *
 483  * Return value:
 484  *
 485  * Since: 1.0
 486  **/
 487 hb_bool_t
 488 hb_font_get_glyph_h_origin (hb_font_t *font,
 489                             hb_codepoint_t glyph,
 490                             hb_position_t *x, hb_position_t *y)
 491 {
 492   return font->get_glyph_h_origin (glyph, x, y);
 493 }
 494
 495 /**
 496  * hb_font_get_glyph_v_origin:
 497  * @font: a font.
 498  * @glyph:
 499  * @x: (out):
 500  * @y: (out):
 501  *
 502  *
 503  *
 504  * Return value:
 505  *
 506  * Since: 1.0
 507  **/
 508 hb_bool_t
 509 hb_font_get_glyph_v_origin (hb_font_t *font,
 510                             hb_codepoint_t glyph,
 511                             hb_position_t *x, hb_position_t *y)
 512 {
 513   return font->get_glyph_v_origin (glyph, x, y);
 514 }
 515
 516 /**
 517  * hb_font_get_glyph_h_kerning:
 518  * @font: a font.
 519  * @left_glyph:
 520  * @right_glyph:
 521  *
 522  *
 523  *
 524  * Return value:
 525  *
 526  * Since: 1.0
 527  **/
 528 hb_position_t
 529 hb_font_get_glyph_h_kerning (hb_font_t *font,
 530                              hb_codepoint_t left_glyph, hb_codepoint_t right_glyph)
 531 {
 532   return font->get_glyph_h_kerning (left_glyph, right_glyph);
 533 }
 534
 535 /**
 536  * hb_font_get_glyph_v_kerning:
 537  * @font: a font.
 538  * @top_glyph:
 539  * @bottom_glyph:
 540  *
 541  *
 542  *
 543  * Return value:
 544  *
 545  * Since: 1.0
 546  **/
 547 hb_position_t
 548 hb_font_get_glyph_v_kerning (hb_font_t *font,
 549                              hb_codepoint_t top_glyph, hb_codepoint_t bottom_glyph)
 550 {
 551   return font->get_glyph_v_kerning (top_glyph, bottom_glyph);
 552 }
 553
 554 /**
 555  * hb_font_get_glyph_extents:
 556  * @font: a font.
 557  * @glyph:
 558  * @extents: (out):
 559  *
 560  *
 561  *
 562  * Return value:
 563  *
 564  * Since: 1.0
 565  **/
 566 hb_bool_t
 567 hb_font_get_glyph_extents (hb_font_t *font,
 568                            hb_codepoint_t glyph,
 569                            hb_glyph_extents_t *extents)
 570 {
 571   return font->get_glyph_extents (glyph, extents);
 572 }
 573
 574 /**
 575  * hb_font_get_glyph_contour_point:
 576  * @font: a font.
 577  * @glyph:
 578  * @point_index:
 579  * @x: (out):
 580  * @y: (out):
 581  *
 582  *
 583  *
 584  * Return value:
 585  *
 586  * Since: 1.0
 587  **/
 588 hb_bool_t
 589 hb_font_get_glyph_contour_point (hb_font_t *font,
 590                                  hb_codepoint_t glyph, unsigned int point_index,
 591                                  hb_position_t *x, hb_position_t *y)
 592 {
 593   return font->get_glyph_contour_point (glyph, point_index, x, y);
 594 }
 595
 596 /**
 597  * hb_font_get_glyph_name:
 598  * @font: a font.
 599  * @glyph:
 600  * @name: (array length=size):
 601  * @size:
 602  *
 603  *
 604  *
 605  * Return value:
 606  *
 607  * Since: 0.9.2
 608  **/
 609 hb_bool_t
 610 hb_font_get_glyph_name (hb_font_t *font,
 611                         hb_codepoint_t glyph,
 612                         char *name, unsigned int size)
 613 {
 614   return font->get_glyph_name (glyph, name, size);
 615 }
 616
 617 /**
 618  * hb_font_get_glyph_from_name:
 619  * @font: a font.
 620  * @name: (array length=len):
 621  * @len:
 622  * @glyph: (out):
 623  *
 624  *
 625  *
 626  * Return value:
 627  *
 628  * Since: 0.9.2
 629  **/
 630 hb_bool_t
 631 hb_font_get_glyph_from_name (hb_font_t *font,
 632                              const char *name, int len, /* -1 means nul-terminated */
 633                              hb_codepoint_t *glyph)
 634 {
 635   return font->get_glyph_from_name (name, len, glyph);
 636 }
 637
 638
 639 /* A bit higher-level, and with fallback */
 640
 641 /**
 642  * hb_font_get_glyph_advance_for_direction:
 643  * @font: a font.
 644  * @glyph:
 645  * @direction:
 646  * @x: (out):
 647  * @y: (out):
 648  *
 649  *
 650  *
 651  * Since: 1.0
 652  **/
 653 void
 654 hb_font_get_glyph_advance_for_direction (hb_font_t *font,
 655                                          hb_codepoint_t glyph,
 656                                          hb_direction_t direction,
 657                                          hb_position_t *x, hb_position_t *y)
 658 {
 659   return font->get_glyph_advance_for_direction (glyph, direction, x, y);
 660 }
 661
 662 /**
 663  * hb_font_get_glyph_origin_for_direction:
 664  * @font: a font.
 665  * @glyph:
 666  * @direction:
 667  * @x: (out):
 668  * @y: (out):
 669  *
 670  *
 671  *
 672  * Since: 1.0
 673  **/
 674 void
 675 hb_font_get_glyph_origin_for_direction (hb_font_t *font,
 676                                         hb_codepoint_t glyph,
 677                                         hb_direction_t direction,
 678                                         hb_position_t *x, hb_position_t *y)
 679 {
 680   return font->get_glyph_origin_for_direction (glyph, direction, x, y);
 681 }
 682
 683 /**
 684  * hb_font_add_glyph_origin_for_direction:
 685  * @font: a font.
 686  * @glyph:
 687  * @direction:
 688  * @x: (out):
 689  * @y: (out):
 690  *
 691  *
 692  *
 693  * Since: 1.0
 694  **/
 695 void
 696 hb_font_add_glyph_origin_for_direction (hb_font_t *font,
 697                                         hb_codepoint_t glyph,
 698                                         hb_direction_t direction,
 699                                         hb_position_t *x, hb_position_t *y)
 700 {
 701   return font->add_glyph_origin_for_direction (glyph, direction, x, y);
 702 }
 703
 704 /**
 705  * hb_font_subtract_glyph_origin_for_direction:
 706  * @font: a font.
 707  * @glyph:
 708  * @direction:
 709  * @x: (out):
 710  * @y: (out):
 711  *
 712  *
 713  *
 714  * Since: 1.0
 715  **/
 716 void
 717 hb_font_subtract_glyph_origin_for_direction (hb_font_t *font,
 718                                              hb_codepoint_t glyph,
 719                                              hb_direction_t direction,
 720                                              hb_position_t *x, hb_position_t *y)
 721 {
 722   return font->subtract_glyph_origin_for_direction (glyph, direction, x, y);
 723 }
 724
 725 /**
 726  * hb_font_get_glyph_kerning_for_direction:
 727  * @font: a font.
 728  * @first_glyph:
 729  * @second_glyph:
 730  * @direction:
 731  * @x: (out):
 732  * @y: (out):
 733  *
 734  *
 735  *
 736  * Since: 1.0
 737  **/
 738 void
 739 hb_font_get_glyph_kerning_for_direction (hb_font_t *font,
 740                                          hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
 741                                          hb_direction_t direction,
 742                                          hb_position_t *x, hb_position_t *y)
 743 {
 744   return font->get_glyph_kerning_for_direction (first_glyph, second_glyph, direction, x, y);
 745 }
 746
 747 /**
 748  * hb_font_get_glyph_extents_for_origin:
 749  * @font: a font.
 750  * @glyph:
 751  * @direction:
 752  * @extents: (out):
 753  *
 754  *
 755  *
 756  * Return value:
 757  *
 758  * Since: 1.0
 759  **/
 760 hb_bool_t
 761 hb_font_get_glyph_extents_for_origin (hb_font_t *font,
 762                                       hb_codepoint_t glyph,
 763                                       hb_direction_t direction,
 764                                       hb_glyph_extents_t *extents)
 765 {
 766   return font->get_glyph_extents_for_origin (glyph, direction, extents);
 767 }
 768
 769 /**
 770  * hb_font_get_glyph_contour_point_for_origin:
 771  * @font: a font.
 772  * @glyph:
 773  * @point_index:
 774  * @direction:
 775  * @x: (out):
 776  * @y: (out):
 777  *
 778  *
 779  *
 780  * Return value:
 781  *
 782  * Since: 1.0
 783  **/
 784 hb_bool_t
 785 hb_font_get_glyph_contour_point_for_origin (hb_font_t *font,
 786                                             hb_codepoint_t glyph, unsigned int point_index,
 787                                             hb_direction_t direction,
 788                                             hb_position_t *x, hb_position_t *y)
 789 {
 790   return font->get_glyph_contour_point_for_origin (glyph, point_index, direction, x, y);
 791 }
 792
 793 /* Generates gidDDD if glyph has no name. */
 794 /**
 795  * hb_font_glyph_to_string:
 796  * @font: a font.
 797  * @glyph:
 798  * @s: (array length=size):
 799  * @size:
 800  *
 801  *
 802  *
 803  * Since: 0.9.2
 804  **/
 805 void
 806 hb_font_glyph_to_string (hb_font_t *font,
 807                          hb_codepoint_t glyph,
 808                          char *s, unsigned int size)
 809 {
 810   font->glyph_to_string (glyph, s, size);
 811 }
 812
 813 /* Parses gidDDD and uniUUUU strings automatically. */
 814 /**
 815  * hb_font_glyph_from_string:
 816  * @font: a font.
 817  * @s: (array length=len) (element-type uint8_t):
 818  * @len:
 819  * @glyph: (out):
 820  *
 821  *
 822  *
 823  * Return value:
 824  *
 825  * Since: 0.9.2
 826  **/
 827 hb_bool_t
 828 hb_font_glyph_from_string (hb_font_t *font,
 829                            const char *s, int len, /* -1 means nul-terminated */
 830                            hb_codepoint_t *glyph)
 831 {
 832   return font->glyph_from_string (s, len, glyph);
 833 }
 834
 835
 836 /*
 837  * hb_font_t
 838  */
 839
 840 /**
 841  * hb_font_create: (Xconstructor)
 842  * @face: a face.
 843  *
 844  *
 845  *
 846  * Return value: (transfer full):
 847  *
 848  * Since: 1.0
 849  **/
 850 hb_font_t *
 851 hb_font_create (hb_face_t *face)
 852 {
 853   hb_font_t *font;
 854
 855   if (unlikely (!face))
 856     face = hb_face_get_empty ();
 857   if (!(font = hb_object_create<hb_font_t> ()))
 858     return hb_font_get_empty ();
 859
 860   hb_face_make_immutable (face);
 861   font->face = hb_face_reference (face);
 862   font->klass = hb_font_funcs_get_empty ();
 863
 864   return font;
 865 }
 866
 867 /**
 868  * hb_font_create_sub_font:
 869  * @parent: parent font.
 870  *
 871  *
 872  *
 873  * Return value: (transfer full):
 874  *
 875  * Since: 1.0
 876  **/
 877 hb_font_t *
 878 hb_font_create_sub_font (hb_font_t *parent)
 879 {
 880   if (unlikely (!parent))
 881     parent = hb_font_get_empty ();
 882
 883   hb_font_t *font = hb_font_create (parent->face);
 884
 885   if (unlikely (hb_object_is_inert (font)))
 886     return font;
 887
 888   hb_font_make_immutable (parent);
 889   font->parent = hb_font_reference (parent);
 890
 891   font->x_scale = parent->x_scale;
 892   font->y_scale = parent->y_scale;
 893   font->x_ppem = parent->x_ppem;
 894   font->y_ppem = parent->y_ppem;
 895
 896   return font;
 897 }
 898
 899 /**
 900  * hb_font_get_empty:
 901  *
 902  *
 903  *
 904  * Return value: (transfer full)
 905  *
 906  * Since: 1.0
 907  **/
 908 hb_font_t *
 909 hb_font_get_empty (void)
 910 {
 911   static const hb_font_t _hb_font_nil = {
 912     HB_OBJECT_HEADER_STATIC,
 913
 914     true, /* immutable */
 915
 916     NULL, /* parent */
 917     const_cast<hb_face_t *> (&_hb_face_nil),
 918
 919     0, /* x_scale */
 920     0, /* y_scale */
 921
 922     0, /* x_ppem */
 923     0, /* y_ppem */
 924
 925     const_cast<hb_font_funcs_t *> (&_hb_font_funcs_nil), /* klass */
 926     NULL, /* user_data */
 927     NULL, /* destroy */
 928
 929     {
 930 #define HB_SHAPER_IMPLEMENT(shaper) HB_SHAPER_DATA_INVALID,
 931 #include "hb-shaper-list.hh"
 932 #undef HB_SHAPER_IMPLEMENT
 933     }
 934   };
 935
 936   return const_cast<hb_font_t *> (&_hb_font_nil);
 937 }
 938
 939 /**
 940  * hb_font_reference: (skip)
 941  * @font: a font.
 942  *
 943  *
 944  *
 945  * Return value: (transfer full):
 946  *
 947  * Since: 1.0
 948  **/
 949 hb_font_t *
 950 hb_font_reference (hb_font_t *font)
 951 {
 952   return hb_object_reference (font);
 953 }
 954
 955 /**
 956  * hb_font_destroy: (skip)
 957  * @font: a font.
 958  *
 959  *
 960  *
 961  * Since: 1.0
 962  **/
 963 void
 964 hb_font_destroy (hb_font_t *font)
 965 {
 966   if (!hb_object_destroy (font)) return;
 967
 968 #define HB_SHAPER_IMPLEMENT(shaper) HB_SHAPER_DATA_DESTROY(shaper, font);
 969 #include "hb-shaper-list.hh"
 970 #undef HB_SHAPER_IMPLEMENT
 971
 972   if (font->destroy)
 973     font->destroy (font->user_data);
 974
 975   hb_font_destroy (font->parent);
 976   hb_face_destroy (font->face);
 977   hb_font_funcs_destroy (font->klass);
 978
 979   free (font);
 980 }
 981
 982 /**
 983  * hb_font_set_user_data: (skip)
 984  * @font: a font.
 985  * @key:
 986  * @data:
 987  * @destroy:
 988  * @replace:
 989  *
 990  *
 991  *
 992  * Return value:
 993  *
 994  * Since: 1.0
 995  **/
 996 hb_bool_t
 997 hb_font_set_user_data (hb_font_t          *font,
 998                        hb_user_data_key_t *key,
 999                        void *              data,
1000                        hb_destroy_func_t   destroy,
1001                        hb_bool_t           replace)
1002 {
1003   return hb_object_set_user_data (font, key, data, destroy, replace);
1004 }
1005
1006 /**
1007  * hb_font_get_user_data: (skip)
1008  * @font: a font.
1009  * @key:
1010  *
1011  *
1012  *
1013  * Return value: (transfer none):
1014  *
1015  * Since: 1.0
1016  **/
1017 void *
1018 hb_font_get_user_data (hb_font_t          *font,
1019                        hb_user_data_key_t *key)
1020 {
1021   return hb_object_get_user_data (font, key);
1022 }
1023
1024 /**
1025  * hb_font_make_immutable:
1026  * @font: a font.
1027  *
1028  *
1029  *
1030  * Since: 1.0
1031  **/
1032 void
1033 hb_font_make_immutable (hb_font_t *font)
1034 {
1035   if (unlikely (hb_object_is_inert (font)))
1036     return;
1037
1038   font->immutable = true;
1039 }
1040
1041 /**
1042  * hb_font_is_immutable:
1043  * @font: a font.
1044  *
1045  *
1046  *
1047  * Return value:
1048  *
1049  * Since: 1.0
1050  **/
1051 hb_bool_t
1052 hb_font_is_immutable (hb_font_t *font)
1053 {
1054   return font->immutable;
1055 }
1056
1057 /**
1058  * hb_font_get_parent:
1059  * @font: a font.
1060  *
1061  *
1062  *
1063  * Return value: (transfer none):
1064  *
1065  * Since: 1.0
1066  **/
1067 hb_font_t *
1068 hb_font_get_parent (hb_font_t *font)
1069 {
1070   return font->parent;
1071 }
1072
1073 /**
1074  * hb_font_get_face:
1075  * @font: a font.
1076  *
1077  *
1078  *
1079  * Return value: (transfer none):
1080  *
1081  * Since: 0.9.2
1082  **/
1083 hb_face_t *
1084 hb_font_get_face (hb_font_t *font)
1085 {
1086   return font->face;
1087 }
1088
1089
1090 /**
1091  * hb_font_set_funcs:
1092  * @font: a font.
1093  * @klass: (closure font_data) (destroy destroy) (scope notified):
1094  * @font_data:
1095  * @destroy:
1096  *
1097  *
1098  *
1099  * Since: 0.9.2
1100  **/
1101 void
1102 hb_font_set_funcs (hb_font_t         *font,
1103                    hb_font_funcs_t   *klass,
1104                    void              *font_data,
1105                    hb_destroy_func_t  destroy)
1106 {
1107   if (font->immutable) {
1108     if (destroy)
1109       destroy (font_data);
1110     return;
1111   }
1112
1113   if (font->destroy)
1114     font->destroy (font->user_data);
1115
1116   if (!klass)
1117     klass = hb_font_funcs_get_empty ();
1118
1119   hb_font_funcs_reference (klass);
1120   hb_font_funcs_destroy (font->klass);
1121   font->klass = klass;
1122   font->user_data = font_data;
1123   font->destroy = destroy;
1124 }
1125
1126 /**
1127  * hb_font_set_funcs_data:
1128  * @font: a font.
1129  * @font_data: (destroy destroy) (scope notified):
1130  * @destroy:
1131  *
1132  *
1133  *
1134  * Since: 0.9.2
1135  **/
1136 void
1137 hb_font_set_funcs_data (hb_font_t         *font,
1138                         void              *font_data,
1139                         hb_destroy_func_t  destroy)
1140 {
1141   /* Destroy user_data? */
1142   if (font->immutable) {
1143     if (destroy)
1144       destroy (font_data);
1145     return;
1146   }
1147
1148   if (font->destroy)
1149     font->destroy (font->user_data);
1150
1151   font->user_data = font_data;
1152   font->destroy = destroy;
1153 }
1154
1155
1156 /**
1157  * hb_font_set_scale:
1158  * @font: a font.
1159  * @x_scale:
1160  * @y_scale:
1161  *
1162  *
1163  *
1164  * Since: 1.0
1165  **/
1166 void
1167 hb_font_set_scale (hb_font_t *font,
1168                    int x_scale,
1169                    int y_scale)
1170 {
1171   if (font->immutable)
1172     return;
1173
1174   font->x_scale = x_scale;
1175   font->y_scale = y_scale;
1176 }
1177
1178 /**
1179  * hb_font_get_scale:
1180  * @font: a font.
1181  * @x_scale: (out):
1182  * @y_scale: (out):
1183  *
1184  *
1185  *
1186  * Since: 1.0
1187  **/
1188 void
1189 hb_font_get_scale (hb_font_t *font,
1190                    int *x_scale,
1191                    int *y_scale)
1192 {
1193   if (x_scale) *x_scale = font->x_scale;
1194   if (y_scale) *y_scale = font->y_scale;
1195 }
1196
1197 /**
1198  * hb_font_set_ppem:
1199  * @font: a font.
1200  * @x_ppem:
1201  * @y_ppem:
1202  *
1203  *
1204  *
1205  * Since: 1.0
1206  **/
1207 void
1208 hb_font_set_ppem (hb_font_t *font,
1209                   unsigned int x_ppem,
1210                   unsigned int y_ppem)
1211 {
1212   if (font->immutable)
1213     return;
1214
1215   font->x_ppem = x_ppem;
1216   font->y_ppem = y_ppem;
1217 }
1218
1219 /**
1220  * hb_font_get_ppem:
1221  * @font: a font.
1222  * @x_ppem: (out):
1223  * @y_ppem: (out):
1224  *
1225  *
1226  *
1227  * Since: 1.0
1228  **/
1229 void
1230 hb_font_get_ppem (hb_font_t *font,
1231                   unsigned int *x_ppem,
1232                   unsigned int *y_ppem)
1233 {
1234   if (x_ppem) *x_ppem = font->x_ppem;
1235   if (y_ppem) *y_ppem = font->y_ppem;
1236 }