harfbuzz/src/hb-face.cc

734 lines
15 KiB
C++
Raw Normal View History

/*
* 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
*/
#include "hb.hh"
#include "hb-face.hh"
#include "hb-blob.hh"
#include "hb-open-file.hh"
#include "hb-ot-face.hh"
#include "hb-ot-cmap-table.hh"
2018-10-27 13:07:33 +02:00
/**
* SECTION:hb-face
* @title: hb-face
* @short_description: Font face objects
2018-10-27 13:07:33 +02:00
* @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.
**/
/**
* hb_face_count:
* @blob: a blob.
*
* Get number of faces in a blob.
*
* Return value: Number of faces in @blob
*
2018-06-06 00:17:39 +02:00
* Since: 1.7.7
**/
unsigned int
hb_face_count (hb_blob_t *blob)
{
if (unlikely (!blob))
return 0;
/* TODO We shouldn't be sanitizing blob. Port to run sanitizer and return if not sane. */
2018-08-02 07:50:06 +02:00
/* Make API signature const after. */
hb_blob_t *sanitized = hb_sanitize_context_t ().sanitize_blob<OT::OpenTypeFontFile> (hb_blob_reference (blob));
const OT::OpenTypeFontFile& ot = *sanitized->as<OT::OpenTypeFontFile> ();
unsigned int ret = ot.get_face_count ();
hb_blob_destroy (sanitized);
return ret;
}
/*
* hb_face_t
*/
DEFINE_NULL_INSTANCE (hb_face_t) =
{
HB_OBJECT_HEADER_STATIC,
2017-10-15 12:11:08 +02:00
nullptr, /* reference_table_func */
nullptr, /* user_data */
nullptr, /* destroy */
0, /* index */
HB_ATOMIC_INT_INIT (1000), /* upem */
HB_ATOMIC_INT_INIT (0), /* num_glyphs */
2018-11-11 22:25:43 +01:00
/* Zero for the rest is fine. */
};
2013-09-06 21:40:22 +02:00
/**
* hb_face_create_for_tables:
2013-09-14 02:34:42 +02:00
* @reference_table_func: (closure user_data) (destroy destroy) (scope notified):
* @user_data:
* @destroy:
*
2013-09-06 21:40:22 +02:00
*
*
* Return value: (transfer full)
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
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;
face->num_glyphs.set_relaxed (-1);
face->data.init0 (face);
face->table.init0 (face);
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;
closure = (hb_face_for_data_closure_t *) calloc (1, sizeof (hb_face_for_data_closure_t));
if (unlikely (!closure))
2017-10-15 12:11:08 +02:00
return nullptr;
closure->blob = blob;
closure->index = index;
return closure;
}
static void
_hb_face_for_data_closure_destroy (void *data)
{
hb_face_for_data_closure_t *closure = (hb_face_for_data_closure_t *) data;
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);
const OT::OpenTypeFontFile &ot_file = *data->blob->as<OT::OpenTypeFontFile> ();
unsigned int base_offset;
const OT::OpenTypeFontFace &ot_face = ot_file.get_face (data->index, &base_offset);
const OT::OpenTypeTable &table = ot_face.get_table_by_tag (tag);
hb_blob_t *blob = hb_blob_create_sub_blob (data->blob, base_offset + table.offset, table.length);
return blob;
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_create: (Xconstructor)
* @blob:
* @index:
*
2013-09-06 21:40:22 +02:00
*
*
* Return value: (transfer full):
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
hb_face_t *
hb_face_create (hb_blob_t *blob,
unsigned int index)
{
hb_face_t *face;
if (unlikely (!blob))
blob = hb_blob_get_empty ();
blob = hb_sanitize_context_t ().sanitize_blob<OT::OpenTypeFontFile> (hb_blob_reference (blob));
hb_face_for_data_closure_t *closure = _hb_face_for_data_closure_create (blob, index);
if (unlikely (!closure))
{
hb_blob_destroy (blob);
return hb_face_get_empty ();
}
face = hb_face_create_for_tables (_hb_face_for_data_reference_table,
closure,
_hb_face_for_data_closure_destroy);
2017-02-04 00:42:03 +01:00
face->index = index;
return face;
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_get_empty:
*
*
2013-09-06 21:40:22 +02:00
*
* Return value: (transfer full)
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
hb_face_t *
hb_face_get_empty ()
{
return const_cast<hb_face_t *> (&Null (hb_face_t));
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_reference: (skip)
* @face: a face.
*
*
*
* Return value:
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
hb_face_t *
hb_face_reference (hb_face_t *face)
{
return hb_object_reference (face);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_destroy: (skip)
* @face: a face.
*
*
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
void
hb_face_destroy (hb_face_t *face)
{
if (!hb_object_destroy (face)) return;
for (hb_face_t::plan_node_t *node = face->shape_plans; node; )
{
hb_face_t::plan_node_t *next = node->next;
hb_shape_plan_destroy (node->shape_plan);
free (node);
node = next;
}
face->data.fini ();
face->table.fini ();
if (face->destroy)
face->destroy (face->user_data);
free (face);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_set_user_data: (skip)
* @face: a face.
* @key:
* @data:
* @destroy:
* @replace:
*
2013-09-06 21:40:22 +02:00
*
*
* Return value:
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
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);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_get_user_data: (skip)
* @face: a face.
* @key:
*
2013-09-06 21:40:22 +02:00
*
*
* Return value: (transfer none):
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
void *
2018-08-02 07:50:06 +02:00
hb_face_get_user_data (const hb_face_t *face,
hb_user_data_key_t *key)
{
return hb_object_get_user_data (face, key);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_make_immutable:
* @face: a face.
*
*
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
void
hb_face_make_immutable (hb_face_t *face)
{
if (hb_object_is_immutable (face))
2018-09-26 21:03:07 +02:00
return;
hb_object_make_immutable (face);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_is_immutable:
* @face: a face.
*
*
*
* Return value:
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
hb_bool_t
2018-08-02 07:50:06 +02:00
hb_face_is_immutable (const hb_face_t *face)
{
return hb_object_is_immutable (face);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_reference_table:
* @face: a face.
* @tag:
*
2013-09-06 21:40:22 +02:00
*
*
* Return value: (transfer full):
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
hb_blob_t *
2018-08-02 07:50:06 +02:00
hb_face_reference_table (const hb_face_t *face,
hb_tag_t tag)
{
if (unlikely (tag == HB_TAG_NONE))
return hb_blob_get_empty ();
return face->reference_table (tag);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_reference_blob:
* @face: a face.
*
*
2013-09-06 21:40:22 +02:00
*
* Return value: (transfer full):
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
hb_blob_t *
hb_face_reference_blob (hb_face_t *face)
{
return face->reference_table (HB_TAG_NONE);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_set_index:
* @face: a face.
* @index:
*
2013-09-06 21:40:22 +02:00
*
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
void
hb_face_set_index (hb_face_t *face,
unsigned int index)
{
if (hb_object_is_immutable (face))
return;
face->index = index;
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_get_index:
* @face: a face.
*
*
*
* Return value:
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
unsigned int
2018-08-02 07:50:06 +02:00
hb_face_get_index (const hb_face_t *face)
{
return face->index;
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_set_upem:
* @face: a face.
* @upem:
*
2013-09-06 21:40:22 +02:00
*
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
void
hb_face_set_upem (hb_face_t *face,
unsigned int upem)
{
if (hb_object_is_immutable (face))
return;
face->upem.set_relaxed (upem);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_get_upem:
* @face: a face.
*
*
*
* Return value:
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.2
2013-09-06 21:40:22 +02:00
**/
unsigned int
2018-08-02 07:50:06 +02:00
hb_face_get_upem (const hb_face_t *face)
{
return face->get_upem ();
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_set_glyph_count:
* @face: a face.
* @glyph_count:
*
2013-09-06 21:40:22 +02:00
*
*
* Since: 0.9.7
2013-09-06 21:40:22 +02:00
**/
void
hb_face_set_glyph_count (hb_face_t *face,
unsigned int glyph_count)
{
if (hb_object_is_immutable (face))
return;
face->num_glyphs.set_relaxed (glyph_count);
}
2013-09-06 21:40:22 +02:00
/**
* hb_face_get_glyph_count:
* @face: a face.
*
*
*
* Return value:
2013-09-06 21:40:22 +02:00
*
* Since: 0.9.7
2013-09-06 21:40:22 +02:00
**/
unsigned int
2018-08-02 07:50:06 +02:00
hb_face_get_glyph_count (const hb_face_t *face)
{
return face->get_num_glyphs ();
}
/**
* hb_face_get_table_tags:
* @face: a face.
* @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.
*
* 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
2018-08-02 07:50:06 +02:00
hb_face_get_table_tags (const hb_face_t *face,
unsigned int start_offset,
unsigned int *table_count, /* IN/OUT */
hb_tag_t *table_tags /* OUT */)
{
2018-06-10 01:04:28 +02:00
if (face->destroy != (hb_destroy_func_t) _hb_face_for_data_closure_destroy)
{
if (table_count)
*table_count = 0;
return 0;
}
hb_face_for_data_closure_t *data = (hb_face_for_data_closure_t *) face->user_data;
const OT::OpenTypeFontFile &ot_file = *data->blob->as<OT::OpenTypeFontFile> ();
const OT::OpenTypeFontFace &ot_face = ot_file.get_face (data->index);
return ot_face.get_table_tags (start_offset, table_count, table_tags);
}
/*
* Character set.
*/
#ifndef HB_NO_FACE_COLLECT_UNICODES
/**
* hb_face_collect_unicodes:
* @face: font face.
* @out: set to add Unicode characters covered by @face to.
*
2018-09-10 11:37:24 +02:00
* Since: 1.9.0
*/
void
hb_face_collect_unicodes (hb_face_t *face,
hb_set_t *out)
{
face->table.cmap->collect_unicodes (out, face->get_num_glyphs ());
}
/**
* hb_face_collect_variation_selectors:
* @face: font face.
* @out: set to add Variation Selector characters covered by @face to.
*
*
*
2018-09-10 11:37:24 +02:00
* Since: 1.9.0
*/
void
hb_face_collect_variation_selectors (hb_face_t *face,
hb_set_t *out)
{
2018-11-06 05:08:33 +01:00
face->table.cmap->collect_variation_selectors (out);
}
/**
* hb_face_collect_variation_unicodes:
* @face: font face.
* @out: set to add Unicode characters for @variation_selector covered by @face to.
*
*
*
2018-09-10 11:37:24 +02:00
* Since: 1.9.0
*/
void
hb_face_collect_variation_unicodes (hb_face_t *face,
hb_codepoint_t variation_selector,
hb_set_t *out)
{
2018-11-06 05:08:33 +01:00
face->table.cmap->collect_variation_unicodes (variation_selector, out);
}
#endif
/*
* face-builder: A face that has add_table().
*/
struct hb_face_builder_data_t
{
struct table_entry_t
{
int cmp (hb_tag_t t) const
{
2018-11-24 07:07:15 +01:00
if (t < tag) return -1;
if (t > tag) return -1;
return 0;
}
hb_tag_t tag;
hb_blob_t *blob;
};
hb_vector_t<table_entry_t> tables;
};
static hb_face_builder_data_t *
_hb_face_builder_data_create ()
{
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;
2018-12-22 00:46:51 +01:00
for (unsigned int i = 0; i < data->tables.length; 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)
{
2018-12-22 00:46:51 +01:00
unsigned int table_count = data->tables.length;
unsigned int face_length = table_count * 16 + 12;
for (unsigned int i = 0; i < table_count; i++)
face_length += hb_ceil_to_4 (hb_blob_get_length (data->tables[i].blob));
char *buf = (char *) malloc (face_length);
if (unlikely (!buf))
return nullptr;
hb_serialize_context_t c (buf, face_length);
c.propagate_error (data->tables);
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;
2018-12-18 22:49:08 +01:00
bool ret = f->serialize_single (&c, sfnt_tag, data->tables.as_array ());
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 *
_hb_face_builder_reference_table (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
{
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().
*
* Return value: (transfer full): New face.
*
2018-09-10 11:37:24 +02:00
* Since: 1.9.0
**/
hb_face_t *
hb_face_builder_create ()
{
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().
*
2018-09-10 11:37:24 +02:00
* Since: 1.9.0
**/
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 ();
if (data->tables.in_error())
return false;
entry->tag = tag;
entry->blob = hb_blob_reference (blob);
return true;
}