1/*
2 * Copyright © 2009 Red Hat, Inc.
3 *
4 * This is part of HarfBuzz, a text shaping library.
5 *
6 * Permission is hereby granted, without written agreement and without
7 * license or royalty fees, to use, copy, modify, and distribute this
8 * software and its documentation for any purpose, provided that the
9 * above copyright notice and the following two paragraphs appear in
10 * all copies of this software.
11 *
12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
16 * DAMAGE.
17 *
18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
23 *
24 * Red Hat Author(s): Behdad Esfahbod
25 */
26
27#if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
28#error "Include <hb.h> instead."
29#endif
30
31#ifndef HB_FACE_H
32#define HB_FACE_H
33
34#include "hb-common.h"
35#include "hb-blob.h"
36#include "hb-map.h"
37#include "hb-set.h"
38
39HB_BEGIN_DECLS
40
41
42HB_EXTERN unsigned int
43hb_face_count (hb_blob_t *blob);
44
45
46/*
47 * hb_face_t
48 */
49
50/**
51 * hb_face_t:
52 *
53 * Data type for holding font faces.
54 *
55 **/
56typedef struct hb_face_t hb_face_t;
57
58HB_EXTERN hb_face_t *
59hb_face_create (hb_blob_t *blob,
60 unsigned int index);
61
62/**
63 * hb_reference_table_func_t:
64 * @face: an #hb_face_t to reference table for
65 * @tag: the tag of the table to reference
66 * @user_data: User data pointer passed by the caller
67 *
68 * Callback function for hb_face_create_for_tables().
69 *
70 * Return value: (transfer full): A pointer to the @tag table within @face
71 *
72 * Since: 0.9.2
73 */
74
75typedef hb_blob_t * (*hb_reference_table_func_t) (hb_face_t *face, hb_tag_t tag, void *user_data);
76
77/* calls destroy() when not needing user_data anymore */
78HB_EXTERN hb_face_t *
79hb_face_create_for_tables (hb_reference_table_func_t reference_table_func,
80 void *user_data,
81 hb_destroy_func_t destroy);
82
83HB_EXTERN hb_face_t *
84hb_face_get_empty (void);
85
86HB_EXTERN hb_face_t *
87hb_face_reference (hb_face_t *face);
88
89HB_EXTERN void
90hb_face_destroy (hb_face_t *face);
91
92HB_EXTERN hb_bool_t
93hb_face_set_user_data (hb_face_t *face,
94 hb_user_data_key_t *key,
95 void * data,
96 hb_destroy_func_t destroy,
97 hb_bool_t replace);
98
99HB_EXTERN void *
100hb_face_get_user_data (const hb_face_t *face,
101 hb_user_data_key_t *key);
102
103HB_EXTERN void
104hb_face_make_immutable (hb_face_t *face);
105
106HB_EXTERN hb_bool_t
107hb_face_is_immutable (const hb_face_t *face);
108
109
110HB_EXTERN hb_blob_t *
111hb_face_reference_table (const hb_face_t *face,
112 hb_tag_t tag);
113
114HB_EXTERN hb_blob_t *
115hb_face_reference_blob (hb_face_t *face);
116
117HB_EXTERN void
118hb_face_set_index (hb_face_t *face,
119 unsigned int index);
120
121HB_EXTERN unsigned int
122hb_face_get_index (const hb_face_t *face);
123
124HB_EXTERN void
125hb_face_set_upem (hb_face_t *face,
126 unsigned int upem);
127
128HB_EXTERN unsigned int
129hb_face_get_upem (const hb_face_t *face);
130
131HB_EXTERN void
132hb_face_set_glyph_count (hb_face_t *face,
133 unsigned int glyph_count);
134
135HB_EXTERN unsigned int
136hb_face_get_glyph_count (const hb_face_t *face);
137
138HB_EXTERN unsigned int
139hb_face_get_table_tags (const hb_face_t *face,
140 unsigned int start_offset,
141 unsigned int *table_count, /* IN/OUT */
142 hb_tag_t *table_tags /* OUT */);
143
144
145/*
146 * Character set.
147 */
148
149HB_EXTERN void
150hb_face_collect_unicodes (hb_face_t *face,
151 hb_set_t *out);
152
153HB_EXTERN void
154hb_face_collect_nominal_glyph_mapping (hb_face_t *face,
155 hb_map_t *mapping,
156 hb_set_t *unicodes);
157
158HB_EXTERN void
159hb_face_collect_variation_selectors (hb_face_t *face,
160 hb_set_t *out);
161
162HB_EXTERN void
163hb_face_collect_variation_unicodes (hb_face_t *face,
164 hb_codepoint_t variation_selector,
165 hb_set_t *out);
166
167
168/*
169 * Builder face.
170 */
171
172HB_EXTERN hb_face_t *
173hb_face_builder_create (void);
174
175HB_EXTERN hb_bool_t
176hb_face_builder_add_table (hb_face_t *face,
177 hb_tag_t tag,
178 hb_blob_t *blob);
179
180HB_EXTERN void
181hb_face_builder_sort_tables (hb_face_t *face,
182 const hb_tag_t *tags);
183
184
185HB_END_DECLS
186
187#endif /* HB_FACE_H */
188