xref: /aosp_15_r20/external/harfbuzz_ng/src/hb-ot-meta.cc (revision 2d1272b857b1f7575e6e246373e1cb218663db8a)
1*2d1272b8SAndroid Build Coastguard Worker /*
2*2d1272b8SAndroid Build Coastguard Worker  * Copyright © 2019  Ebrahim Byagowi
3*2d1272b8SAndroid Build Coastguard Worker  *
4*2d1272b8SAndroid Build Coastguard Worker  *  This is part of HarfBuzz, a text shaping library.
5*2d1272b8SAndroid Build Coastguard Worker  *
6*2d1272b8SAndroid Build Coastguard Worker  * Permission is hereby granted, without written agreement and without
7*2d1272b8SAndroid Build Coastguard Worker  * license or royalty fees, to use, copy, modify, and distribute this
8*2d1272b8SAndroid Build Coastguard Worker  * software and its documentation for any purpose, provided that the
9*2d1272b8SAndroid Build Coastguard Worker  * above copyright notice and the following two paragraphs appear in
10*2d1272b8SAndroid Build Coastguard Worker  * all copies of this software.
11*2d1272b8SAndroid Build Coastguard Worker  *
12*2d1272b8SAndroid Build Coastguard Worker  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
13*2d1272b8SAndroid Build Coastguard Worker  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
14*2d1272b8SAndroid Build Coastguard Worker  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
15*2d1272b8SAndroid Build Coastguard Worker  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
16*2d1272b8SAndroid Build Coastguard Worker  * DAMAGE.
17*2d1272b8SAndroid Build Coastguard Worker  *
18*2d1272b8SAndroid Build Coastguard Worker  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19*2d1272b8SAndroid Build Coastguard Worker  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20*2d1272b8SAndroid Build Coastguard Worker  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
21*2d1272b8SAndroid Build Coastguard Worker  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
22*2d1272b8SAndroid Build Coastguard Worker  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
23*2d1272b8SAndroid Build Coastguard Worker  */
24*2d1272b8SAndroid Build Coastguard Worker 
25*2d1272b8SAndroid Build Coastguard Worker #include "hb.hh"
26*2d1272b8SAndroid Build Coastguard Worker 
27*2d1272b8SAndroid Build Coastguard Worker #ifndef HB_NO_META
28*2d1272b8SAndroid Build Coastguard Worker 
29*2d1272b8SAndroid Build Coastguard Worker #include "hb-ot-meta-table.hh"
30*2d1272b8SAndroid Build Coastguard Worker 
31*2d1272b8SAndroid Build Coastguard Worker /**
32*2d1272b8SAndroid Build Coastguard Worker  * SECTION:hb-ot-meta
33*2d1272b8SAndroid Build Coastguard Worker  * @title: hb-ot-meta
34*2d1272b8SAndroid Build Coastguard Worker  * @short_description: OpenType Metadata
35*2d1272b8SAndroid Build Coastguard Worker  * @include: hb-ot.h
36*2d1272b8SAndroid Build Coastguard Worker  *
37*2d1272b8SAndroid Build Coastguard Worker  * Functions for fetching metadata from fonts.
38*2d1272b8SAndroid Build Coastguard Worker  **/
39*2d1272b8SAndroid Build Coastguard Worker 
40*2d1272b8SAndroid Build Coastguard Worker /**
41*2d1272b8SAndroid Build Coastguard Worker  * hb_ot_meta_get_entry_tags:
42*2d1272b8SAndroid Build Coastguard Worker  * @face: a face object
43*2d1272b8SAndroid Build Coastguard Worker  * @start_offset: iteration's start offset
44*2d1272b8SAndroid Build Coastguard Worker  * @entries_count:(inout) (optional): buffer size as input, filled size as output
45*2d1272b8SAndroid Build Coastguard Worker  * @entries: (out caller-allocates) (array length=entries_count): entries tags buffer
46*2d1272b8SAndroid Build Coastguard Worker  *
47*2d1272b8SAndroid Build Coastguard Worker  * Fetches all available feature types.
48*2d1272b8SAndroid Build Coastguard Worker  *
49*2d1272b8SAndroid Build Coastguard Worker  * Return value: Number of all available feature types.
50*2d1272b8SAndroid Build Coastguard Worker  *
51*2d1272b8SAndroid Build Coastguard Worker  * Since: 2.6.0
52*2d1272b8SAndroid Build Coastguard Worker  **/
53*2d1272b8SAndroid Build Coastguard Worker unsigned int
hb_ot_meta_get_entry_tags(hb_face_t * face,unsigned int start_offset,unsigned int * entries_count,hb_ot_meta_tag_t * entries)54*2d1272b8SAndroid Build Coastguard Worker hb_ot_meta_get_entry_tags (hb_face_t        *face,
55*2d1272b8SAndroid Build Coastguard Worker 			   unsigned int      start_offset,
56*2d1272b8SAndroid Build Coastguard Worker 			   unsigned int     *entries_count, /* IN/OUT.  May be NULL. */
57*2d1272b8SAndroid Build Coastguard Worker 			   hb_ot_meta_tag_t *entries        /* OUT.     May be NULL. */)
58*2d1272b8SAndroid Build Coastguard Worker {
59*2d1272b8SAndroid Build Coastguard Worker   return face->table.meta->get_entries (start_offset, entries_count, entries);
60*2d1272b8SAndroid Build Coastguard Worker }
61*2d1272b8SAndroid Build Coastguard Worker 
62*2d1272b8SAndroid Build Coastguard Worker /**
63*2d1272b8SAndroid Build Coastguard Worker  * hb_ot_meta_reference_entry:
64*2d1272b8SAndroid Build Coastguard Worker  * @face: a #hb_face_t object.
65*2d1272b8SAndroid Build Coastguard Worker  * @meta_tag: tag of metadata you like to have.
66*2d1272b8SAndroid Build Coastguard Worker  *
67*2d1272b8SAndroid Build Coastguard Worker  * It fetches metadata entry of a given tag from a font.
68*2d1272b8SAndroid Build Coastguard Worker  *
69*2d1272b8SAndroid Build Coastguard Worker  * Returns: (transfer full): A blob containing the blob.
70*2d1272b8SAndroid Build Coastguard Worker  *
71*2d1272b8SAndroid Build Coastguard Worker  * Since: 2.6.0
72*2d1272b8SAndroid Build Coastguard Worker  **/
73*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_ot_meta_reference_entry(hb_face_t * face,hb_ot_meta_tag_t meta_tag)74*2d1272b8SAndroid Build Coastguard Worker hb_ot_meta_reference_entry (hb_face_t *face, hb_ot_meta_tag_t meta_tag)
75*2d1272b8SAndroid Build Coastguard Worker {
76*2d1272b8SAndroid Build Coastguard Worker   return face->table.meta->reference_entry (meta_tag);
77*2d1272b8SAndroid Build Coastguard Worker }
78*2d1272b8SAndroid Build Coastguard Worker 
79*2d1272b8SAndroid Build Coastguard Worker #endif
80