hb-face.cc 14.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
 * Copyright © 2009  Red Hat, Inc.
 * Copyright © 2012  Google, Inc.
 *
 *  This is part of HarfBuzz, a text shaping library.
 *
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the
 * above copyright notice and the following two paragraphs appear in
 * all copies of this software.
 *
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 * Red Hat Author(s): Behdad Esfahbod
 * Google Author(s): Behdad Esfahbod
 */

29
#include "hb.hh"
30

31 32 33
#include "hb-face.hh"
#include "hb-blob.hh"
#include "hb-open-file.hh"
34
#include "hb-ot-face.hh"
35
#include "hb-ot-cmap-table.hh"
36 37


B
Behdad Esfahbod 已提交
38 39
/**
 * SECTION:hb-face
40
 * @title: hb-face
41
 * @short_description: Font face objects
B
Behdad Esfahbod 已提交
42 43 44 45 46 47 48 49 50
 * @include: hb.h
 *
 * Font face is objects represent a single face in a font family.
 * More exactly, a font face represents a single face in a binary font file.
 * Font faces are typically built from a binary blob and a face index.
 * Font faces are used to create fonts.
 **/


51
/**
B
Behdad Esfahbod 已提交
52 53
 * hb_face_count:
 * @blob: a blob.
54
 *
B
Behdad Esfahbod 已提交
55
 * Get number of faces in a blob.
56
 *
B
Behdad Esfahbod 已提交
57
 * Return value: Number of faces in @blob
58
 *
B
1.7.7  
Behdad Esfahbod 已提交
59
 * Since: 1.7.7
60 61 62 63 64 65 66
 **/
unsigned int
hb_face_count (hb_blob_t *blob)
{
  if (unlikely (!blob))
    return 0;

67
  /* TODO We shouldn't be sanitizing blob.  Port to run sanitizer and return if not sane. */
68
  /* Make API signature const after. */
69
  hb_blob_t *sanitized = hb_sanitize_context_t ().sanitize_blob<OT::OpenTypeFontFile> (hb_blob_reference (blob));
E
Ebrahim Byagowi 已提交
70
  const OT::OpenTypeFontFile& ot = *sanitized->as<OT::OpenTypeFontFile> ();
71 72
  unsigned int ret = ot.get_face_count ();
  hb_blob_destroy (sanitized);
73

74
  return ret;
75 76
}

77 78 79 80
/*
 * hb_face_t
 */

81 82
DEFINE_NULL_INSTANCE (hb_face_t) =
{
83 84
  HB_OBJECT_HEADER_STATIC,

B
Behdad Esfahbod 已提交
85 86 87
  nullptr, /* reference_table_func */
  nullptr, /* user_data */
  nullptr, /* destroy */
88 89

  0,    /* index */
90 91
  HB_ATOMIC_INT_INIT (1000), /* upem */
  HB_ATOMIC_INT_INIT (0),    /* num_glyphs */
92

B
Minor  
Behdad Esfahbod 已提交
93
  /* Zero for the rest is fine. */
94 95 96
};


97 98
/**
 * hb_face_create_for_tables:
99
 * @reference_table_func: (closure user_data) (destroy destroy) (scope notified):
100 101 102
 * @user_data:
 * @destroy:
 *
103 104 105 106
 *
 *
 * Return value: (transfer full)
 *
107
 * Since: 0.9.2
108
 **/
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
hb_face_t *
hb_face_create_for_tables (hb_reference_table_func_t  reference_table_func,
			   void                      *user_data,
			   hb_destroy_func_t          destroy)
{
  hb_face_t *face;

  if (!reference_table_func || !(face = hb_object_create<hb_face_t> ())) {
    if (destroy)
      destroy (user_data);
    return hb_face_get_empty ();
  }

  face->reference_table_func = reference_table_func;
  face->user_data = user_data;
  face->destroy = destroy;

126
  face->num_glyphs.set_relaxed (-1);
127

128
  face->data.init0 (face);
129 130
  face->table.init0 (face);

131 132 133 134 135 136 137 138 139 140 141 142 143 144
  return face;
}


typedef struct hb_face_for_data_closure_t {
  hb_blob_t *blob;
  unsigned int  index;
} hb_face_for_data_closure_t;

static hb_face_for_data_closure_t *
_hb_face_for_data_closure_create (hb_blob_t *blob, unsigned int index)
{
  hb_face_for_data_closure_t *closure;

145
  closure = (hb_face_for_data_closure_t *) calloc (1, sizeof (hb_face_for_data_closure_t));
146
  if (unlikely (!closure))
B
Behdad Esfahbod 已提交
147
    return nullptr;
148 149 150 151 152 153 154 155

  closure->blob = blob;
  closure->index = index;

  return closure;
}

static void
156
_hb_face_for_data_closure_destroy (void *data)
157
{
158 159
  hb_face_for_data_closure_t *closure = (hb_face_for_data_closure_t *) data;

160 161 162 163 164 165 166 167 168 169 170 171
  hb_blob_destroy (closure->blob);
  free (closure);
}

static hb_blob_t *
_hb_face_for_data_reference_table (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
{
  hb_face_for_data_closure_t *data = (hb_face_for_data_closure_t *) user_data;

  if (tag == HB_TAG_NONE)
    return hb_blob_reference (data->blob);

172
  const OT::OpenTypeFontFile &ot_file = *data->blob->as<OT::OpenTypeFontFile> ();
173 174
  unsigned int base_offset;
  const OT::OpenTypeFontFace &ot_face = ot_file.get_face (data->index, &base_offset);
175 176 177

  const OT::OpenTypeTable &table = ot_face.get_table_by_tag (tag);

178
  hb_blob_t *blob = hb_blob_create_sub_blob (data->blob, base_offset + table.offset, table.length);
179 180 181 182

  return blob;
}

183
/**
184
 * hb_face_create: (Xconstructor)
185 186 187
 * @blob:
 * @index:
 *
188 189 190 191
 *
 *
 * Return value: (transfer full):
 *
192
 * Since: 0.9.2
193
 **/
194 195 196 197 198 199
hb_face_t *
hb_face_create (hb_blob_t    *blob,
		unsigned int  index)
{
  hb_face_t *face;

B
Behdad Esfahbod 已提交
200 201
  if (unlikely (!blob))
    blob = hb_blob_get_empty ();
202

203
  hb_face_for_data_closure_t *closure = _hb_face_for_data_closure_create (hb_sanitize_context_t ().sanitize_blob<OT::OpenTypeFontFile> (hb_blob_reference (blob)), index);
204 205 206 207 208 209

  if (unlikely (!closure))
    return hb_face_get_empty ();

  face = hb_face_create_for_tables (_hb_face_for_data_reference_table,
				    closure,
210
				    _hb_face_for_data_closure_destroy);
211

212
  face->index = index;
213 214 215 216

  return face;
}

217 218 219
/**
 * hb_face_get_empty:
 *
220
 *
221 222 223
 *
 * Return value: (transfer full)
 *
224
 * Since: 0.9.2
225
 **/
226
hb_face_t *
227
hb_face_get_empty ()
228
{
229
  return const_cast<hb_face_t *> (&Null(hb_face_t));
230 231 232
}


233 234 235 236 237
/**
 * hb_face_reference: (skip)
 * @face: a face.
 *
 *
238 239
 *
 * Return value:
240
 *
241
 * Since: 0.9.2
242
 **/
243 244 245 246 247 248
hb_face_t *
hb_face_reference (hb_face_t *face)
{
  return hb_object_reference (face);
}

249 250 251 252
/**
 * hb_face_destroy: (skip)
 * @face: a face.
 *
253
 *
254
 *
255
 * Since: 0.9.2
256
 **/
257 258 259 260 261
void
hb_face_destroy (hb_face_t *face)
{
  if (!hb_object_destroy (face)) return;

262
  for (hb_face_t::plan_node_t *node = face->shape_plans; node; )
263 264 265 266 267 268 269
  {
    hb_face_t::plan_node_t *next = node->next;
    hb_shape_plan_destroy (node->shape_plan);
    free (node);
    node = next;
  }

270
  face->data.fini ();
271 272
  face->table.fini ();

273 274 275 276 277 278
  if (face->destroy)
    face->destroy (face->user_data);

  free (face);
}

279 280 281
/**
 * hb_face_set_user_data: (skip)
 * @face: a face.
282 283 284 285 286
 * @key:
 * @data:
 * @destroy:
 * @replace:
 *
287 288
 *
 *
289
 * Return value:
290
 *
291
 * Since: 0.9.2
292
 **/
293 294 295 296 297 298 299 300 301 302
hb_bool_t
hb_face_set_user_data (hb_face_t          *face,
		       hb_user_data_key_t *key,
		       void *              data,
		       hb_destroy_func_t   destroy,
		       hb_bool_t           replace)
{
  return hb_object_set_user_data (face, key, data, destroy, replace);
}

303 304 305
/**
 * hb_face_get_user_data: (skip)
 * @face: a face.
306 307
 * @key:
 *
308 309 310 311
 *
 *
 * Return value: (transfer none):
 *
312
 * Since: 0.9.2
313
 **/
314
void *
315
hb_face_get_user_data (const hb_face_t    *face,
316 317 318 319 320
		       hb_user_data_key_t *key)
{
  return hb_object_get_user_data (face, key);
}

321 322 323 324
/**
 * hb_face_make_immutable:
 * @face: a face.
 *
325
 *
326
 *
327
 * Since: 0.9.2
328
 **/
329 330 331
void
hb_face_make_immutable (hb_face_t *face)
{
332
  if (hb_object_is_immutable (face))
333
    return;
334

335
  hb_object_make_immutable (face);
336 337
}

338 339 340 341 342
/**
 * hb_face_is_immutable:
 * @face: a face.
 *
 *
343 344
 *
 * Return value:
345
 *
346
 * Since: 0.9.2
347
 **/
348
hb_bool_t
349
hb_face_is_immutable (const hb_face_t *face)
350
{
351
  return hb_object_is_immutable (face);
352 353 354
}


355 356 357
/**
 * hb_face_reference_table:
 * @face: a face.
358 359
 * @tag:
 *
360 361 362 363
 *
 *
 * Return value: (transfer full):
 *
364
 * Since: 0.9.2
365
 **/
366
hb_blob_t *
367 368
hb_face_reference_table (const hb_face_t *face,
			 hb_tag_t tag)
369 370 371 372
{
  return face->reference_table (tag);
}

373 374 375 376
/**
 * hb_face_reference_blob:
 * @face: a face.
 *
377
 *
378 379 380
 *
 * Return value: (transfer full):
 *
S
Sascha Brawer 已提交
381
 * Since: 0.9.2
382
 **/
383 384 385 386 387 388
hb_blob_t *
hb_face_reference_blob (hb_face_t *face)
{
  return face->reference_table (HB_TAG_NONE);
}

389 390 391
/**
 * hb_face_set_index:
 * @face: a face.
392 393
 * @index:
 *
394 395
 *
 *
S
Sascha Brawer 已提交
396
 * Since: 0.9.2
397
 **/
398 399 400 401
void
hb_face_set_index (hb_face_t    *face,
		   unsigned int  index)
{
402
  if (hb_object_is_immutable (face))
403 404 405 406 407
    return;

  face->index = index;
}

408 409 410 411 412
/**
 * hb_face_get_index:
 * @face: a face.
 *
 *
413 414
 *
 * Return value:
415
 *
S
Sascha Brawer 已提交
416
 * Since: 0.9.2
417
 **/
418
unsigned int
419
hb_face_get_index (const hb_face_t *face)
420 421 422 423
{
  return face->index;
}

424 425 426
/**
 * hb_face_set_upem:
 * @face: a face.
427 428
 * @upem:
 *
429 430
 *
 *
S
Sascha Brawer 已提交
431
 * Since: 0.9.2
432
 **/
433 434 435 436
void
hb_face_set_upem (hb_face_t    *face,
		  unsigned int  upem)
{
437
  if (hb_object_is_immutable (face))
438 439
    return;

440
  face->upem.set_relaxed (upem);
441 442
}

443 444 445 446 447
/**
 * hb_face_get_upem:
 * @face: a face.
 *
 *
448 449
 *
 * Return value:
450
 *
451
 * Since: 0.9.2
452
 **/
453
unsigned int
454
hb_face_get_upem (const hb_face_t *face)
455 456 457 458
{
  return face->get_upem ();
}

459 460 461
/**
 * hb_face_set_glyph_count:
 * @face: a face.
462 463
 * @glyph_count:
 *
464 465
 *
 *
S
Sascha Brawer 已提交
466
 * Since: 0.9.7
467
 **/
468 469 470 471
void
hb_face_set_glyph_count (hb_face_t    *face,
			 unsigned int  glyph_count)
{
472
  if (hb_object_is_immutable (face))
473 474
    return;

475
  face->num_glyphs.set_relaxed (glyph_count);
476 477
}

478 479 480 481 482
/**
 * hb_face_get_glyph_count:
 * @face: a face.
 *
 *
483 484
 *
 * Return value:
485
 *
S
Sascha Brawer 已提交
486
 * Since: 0.9.7
487
 **/
488
unsigned int
489
hb_face_get_glyph_count (const hb_face_t *face)
490 491 492 493
{
  return face->get_num_glyphs ();
}

B
Behdad Esfahbod 已提交
494 495 496
/**
 * hb_face_get_table_tags:
 * @face: a face.
B
Behdad Esfahbod 已提交
497 498 499
 * @start_offset: index of first tag to return.
 * @table_count: input length of @table_tags array, output number of items written.
 * @table_tags: array to write tags into.
B
Behdad Esfahbod 已提交
500 501 502 503 504 505 506 507
 *
 * Retrieves table tags for a face, if possible.
 *
 * Return value: total number of tables, or 0 if not possible to list.
 *
 * Since: 1.6.0
 **/
unsigned int
508
hb_face_get_table_tags (const hb_face_t *face,
B
Behdad Esfahbod 已提交
509 510 511 512
			unsigned int  start_offset,
			unsigned int *table_count, /* IN/OUT */
			hb_tag_t     *table_tags /* OUT */)
{
P
prrace 已提交
513
  if (face->destroy != (hb_destroy_func_t) _hb_face_for_data_closure_destroy)
B
Behdad Esfahbod 已提交
514 515 516 517 518
  {
    if (table_count)
      *table_count = 0;
    return 0;
  }
519

B
Behdad Esfahbod 已提交
520 521
  hb_face_for_data_closure_t *data = (hb_face_for_data_closure_t *) face->user_data;

522
  const OT::OpenTypeFontFile &ot_file = *data->blob->as<OT::OpenTypeFontFile> ();
B
Behdad Esfahbod 已提交
523 524 525 526
  const OT::OpenTypeFontFace &ot_face = ot_file.get_face (data->index);

  return ot_face.get_table_tags (start_offset, table_count, table_tags);
}
B
Behdad Esfahbod 已提交
527 528


529 530 531 532
/*
 * Character set.
 */

533

534 535 536 537 538
/**
 * hb_face_collect_unicodes:
 * @face: font face.
 * @out: set to add Unicode characters covered by @face to.
 *
B
1.9.0  
Behdad Esfahbod 已提交
539
 * Since: 1.9.0
540 541 542 543 544
 */
void
hb_face_collect_unicodes (hb_face_t *face,
			  hb_set_t  *out)
{
545
  face->table.cmap->collect_unicodes (out);
546 547 548 549 550 551 552 553 554
}

/**
 * hb_face_collect_variation_selectors:
 * @face: font face.
 * @out: set to add Variation Selector characters covered by @face to.
 *
 *
 *
B
1.9.0  
Behdad Esfahbod 已提交
555
 * Since: 1.9.0
556 557 558 559 560
 */
void
hb_face_collect_variation_selectors (hb_face_t *face,
				     hb_set_t  *out)
{
561
  face->table.cmap->collect_variation_selectors (out);
562 563 564 565 566 567 568 569 570
}

/**
 * hb_face_collect_variation_unicodes:
 * @face: font face.
 * @out: set to add Unicode characters for @variation_selector covered by @face to.
 *
 *
 *
B
1.9.0  
Behdad Esfahbod 已提交
571
 * Since: 1.9.0
572 573 574 575 576 577
 */
void
hb_face_collect_variation_unicodes (hb_face_t *face,
				    hb_codepoint_t variation_selector,
				    hb_set_t  *out)
{
578
  face->table.cmap->collect_variation_unicodes (variation_selector, out);
579 580 581 582
}



B
Behdad Esfahbod 已提交
583 584 585 586 587 588 589 590
/*
 * face-builder: A face that has add_table().
 */

struct hb_face_builder_data_t
{
  struct table_entry_t
  {
591
    int cmp (hb_tag_t t) const
B
Behdad Esfahbod 已提交
592
    {
B
Behdad Esfahbod 已提交
593 594
      if (t < tag) return -1;
      if (t > tag) return -1;
B
Behdad Esfahbod 已提交
595 596 597 598 599 600 601 602 603 604 605
      return 0;
    }

    hb_tag_t   tag;
    hb_blob_t *blob;
  };

  hb_vector_t<table_entry_t, 32> tables;
};

static hb_face_builder_data_t *
606
_hb_face_builder_data_create ()
B
Behdad Esfahbod 已提交
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
{
  hb_face_builder_data_t *data = (hb_face_builder_data_t *) calloc (1, sizeof (hb_face_builder_data_t));
  if (unlikely (!data))
    return nullptr;

  data->tables.init ();

  return data;
}

static void
_hb_face_builder_data_destroy (void *user_data)
{
  hb_face_builder_data_t *data = (hb_face_builder_data_t *) user_data;

  for (unsigned int i = 0; i < data->tables.len; i++)
    hb_blob_destroy (data->tables[i].blob);

  data->tables.fini ();

  free (data);
}

static hb_blob_t *
_hb_face_builder_data_reference_blob (hb_face_builder_data_t *data)
{

  unsigned int table_count = data->tables.len;
  unsigned int face_length = table_count * 16 + 12;

  for (unsigned int i = 0; i < table_count; i++)
638
    face_length += hb_ceil_to_4 (hb_blob_get_length (data->tables[i].blob));
B
Behdad Esfahbod 已提交
639 640 641 642 643 644

  char *buf = (char *) malloc (face_length);
  if (unlikely (!buf))
    return nullptr;

  hb_serialize_context_t c (buf, face_length);
645
  c.propagate_error (data->tables);
B
Behdad Esfahbod 已提交
646 647 648 649 650
  OT::OpenTypeFontFile *f = c.start_serialize<OT::OpenTypeFontFile> ();

  bool is_cff = data->tables.lsearch (HB_TAG ('C','F','F',' ')) || data->tables.lsearch (HB_TAG ('C','F','F','2'));
  hb_tag_t sfnt_tag = is_cff ? OT::OpenTypeFontFile::CFFTag : OT::OpenTypeFontFile::TrueTypeTag;

B
Behdad Esfahbod 已提交
651
  bool ret = f->serialize_single (&c, sfnt_tag, data->tables.as_array ());
B
Behdad Esfahbod 已提交
652 653 654 655 656 657 658 659 660 661 662 663 664

  c.end_serialize ();

  if (unlikely (!ret))
  {
    free (buf);
    return nullptr;
  }

  return hb_blob_create (buf, face_length, HB_MEMORY_MODE_WRITABLE, buf, free);
}

static hb_blob_t *
665
_hb_face_builder_reference_table (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
B
Behdad Esfahbod 已提交
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
{
  hb_face_builder_data_t *data = (hb_face_builder_data_t *) user_data;

  if (!tag)
    return _hb_face_builder_data_reference_blob (data);

  hb_face_builder_data_t::table_entry_t *entry = data->tables.lsearch (tag);
  if (entry)
    return hb_blob_reference (entry->blob);

  return nullptr;
}


/**
 * hb_face_builder_create:
 *
 * Creates a #hb_face_t that can be used with hb_face_builder_add_table().
 * After tables are added to the face, it can be compiled to a binary
 * font file by calling hb_face_reference_blob().
 *
H
HinTak 已提交
687
 * Return value: (transfer full): New face.
B
Behdad Esfahbod 已提交
688
 *
B
1.9.0  
Behdad Esfahbod 已提交
689
 * Since: 1.9.0
B
Behdad Esfahbod 已提交
690 691
 **/
hb_face_t *
692
hb_face_builder_create ()
B
Behdad Esfahbod 已提交
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
{
  hb_face_builder_data_t *data = _hb_face_builder_data_create ();
  if (unlikely (!data)) return hb_face_get_empty ();

  return hb_face_create_for_tables (_hb_face_builder_reference_table,
				    data,
				    _hb_face_builder_data_destroy);
}

/**
 * hb_face_builder_add_table:
 *
 * Add table for @tag with data provided by @blob to the face.  @face must
 * be created using hb_face_builder_create().
 *
B
1.9.0  
Behdad Esfahbod 已提交
708
 * Since: 1.9.0
B
Behdad Esfahbod 已提交
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
 **/
hb_bool_t
hb_face_builder_add_table (hb_face_t *face, hb_tag_t tag, hb_blob_t *blob)
{
  if (unlikely (face->destroy != (hb_destroy_func_t) _hb_face_builder_data_destroy))
    return false;

  hb_face_builder_data_t *data = (hb_face_builder_data_t *) face->user_data;
  hb_face_builder_data_t::table_entry_t *entry = data->tables.push ();

  entry->tag = tag;
  entry->blob = hb_blob_reference (blob);

  return true;
}