1 /*
2 * Copyright © 2011,2014 Google, 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 * Google Author(s): Behdad Esfahbod, Roozbeh Pournader
25 */
26
27 #include "hb.hh"
28
29 #ifndef HB_NO_OT_FONT
30
31 #include "hb-ot.h"
32
33 #include "hb-font.hh"
34 #include "hb-machinery.hh"
35 #include "hb-ot-face.hh"
36
37 #include "hb-ot-cmap-table.hh"
38 #include "hb-ot-glyf-table.hh"
39 #include "hb-ot-cff1-table.hh"
40 #include "hb-ot-cff2-table.hh"
41 #include "hb-ot-hmtx-table.hh"
42 #include "hb-ot-os2-table.hh"
43 #include "hb-ot-post-table.hh"
44 #include "hb-ot-stat-table.hh" // Just so we compile it; unused otherwise.
45 #include "hb-ot-vorg-table.hh"
46 #include "hb-ot-color-cbdt-table.hh"
47 #include "hb-ot-color-sbix-table.hh"
48
49
50 /**
51 * SECTION:hb-ot-font
52 * @title: hb-ot-font
53 * @short_description: OpenType font implementation
54 * @include: hb-ot.h
55 *
56 * Functions for using OpenType fonts with hb_shape(). Note that fonts returned
57 * by hb_font_create() default to using these functions, so most clients would
58 * never need to call these functions directly.
59 **/
60
61
62 static hb_bool_t
hb_ot_get_nominal_glyph(hb_font_t * font HB_UNUSED,void * font_data,hb_codepoint_t unicode,hb_codepoint_t * glyph,void * user_data HB_UNUSED)63 hb_ot_get_nominal_glyph (hb_font_t *font HB_UNUSED,
64 void *font_data,
65 hb_codepoint_t unicode,
66 hb_codepoint_t *glyph,
67 void *user_data HB_UNUSED)
68 {
69 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
70 return ot_face->cmap->get_nominal_glyph (unicode, glyph);
71 }
72
73 static unsigned int
hb_ot_get_nominal_glyphs(hb_font_t * font HB_UNUSED,void * font_data,unsigned int count,const hb_codepoint_t * first_unicode,unsigned int unicode_stride,hb_codepoint_t * first_glyph,unsigned int glyph_stride,void * user_data HB_UNUSED)74 hb_ot_get_nominal_glyphs (hb_font_t *font HB_UNUSED,
75 void *font_data,
76 unsigned int count,
77 const hb_codepoint_t *first_unicode,
78 unsigned int unicode_stride,
79 hb_codepoint_t *first_glyph,
80 unsigned int glyph_stride,
81 void *user_data HB_UNUSED)
82 {
83 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
84 return ot_face->cmap->get_nominal_glyphs (count,
85 first_unicode, unicode_stride,
86 first_glyph, glyph_stride);
87 }
88
89 static hb_bool_t
hb_ot_get_variation_glyph(hb_font_t * font HB_UNUSED,void * font_data,hb_codepoint_t unicode,hb_codepoint_t variation_selector,hb_codepoint_t * glyph,void * user_data HB_UNUSED)90 hb_ot_get_variation_glyph (hb_font_t *font HB_UNUSED,
91 void *font_data,
92 hb_codepoint_t unicode,
93 hb_codepoint_t variation_selector,
94 hb_codepoint_t *glyph,
95 void *user_data HB_UNUSED)
96 {
97 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
98 return ot_face->cmap->get_variation_glyph (unicode, variation_selector, glyph);
99 }
100
101 static void
hb_ot_get_glyph_h_advances(hb_font_t * font,void * font_data,unsigned count,const hb_codepoint_t * first_glyph,unsigned glyph_stride,hb_position_t * first_advance,unsigned advance_stride,void * user_data HB_UNUSED)102 hb_ot_get_glyph_h_advances (hb_font_t* font, void* font_data,
103 unsigned count,
104 const hb_codepoint_t *first_glyph,
105 unsigned glyph_stride,
106 hb_position_t *first_advance,
107 unsigned advance_stride,
108 void *user_data HB_UNUSED)
109 {
110 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
111 const OT::hmtx_accelerator_t &hmtx = *ot_face->hmtx;
112
113 for (unsigned int i = 0; i < count; i++)
114 {
115 *first_advance = font->em_scale_x (hmtx.get_advance (*first_glyph, font));
116 first_glyph = &StructAtOffsetUnaligned<hb_codepoint_t> (first_glyph, glyph_stride);
117 first_advance = &StructAtOffsetUnaligned<hb_position_t> (first_advance, advance_stride);
118 }
119 }
120
121 static void
hb_ot_get_glyph_v_advances(hb_font_t * font,void * font_data,unsigned count,const hb_codepoint_t * first_glyph,unsigned glyph_stride,hb_position_t * first_advance,unsigned advance_stride,void * user_data HB_UNUSED)122 hb_ot_get_glyph_v_advances (hb_font_t* font, void* font_data,
123 unsigned count,
124 const hb_codepoint_t *first_glyph,
125 unsigned glyph_stride,
126 hb_position_t *first_advance,
127 unsigned advance_stride,
128 void *user_data HB_UNUSED)
129 {
130 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
131 const OT::vmtx_accelerator_t &vmtx = *ot_face->vmtx;
132
133 for (unsigned int i = 0; i < count; i++)
134 {
135 *first_advance = font->em_scale_y (-(int) vmtx.get_advance (*first_glyph, font));
136 first_glyph = &StructAtOffsetUnaligned<hb_codepoint_t> (first_glyph, glyph_stride);
137 first_advance = &StructAtOffsetUnaligned<hb_position_t> (first_advance, advance_stride);
138 }
139 }
140
141 static hb_bool_t
hb_ot_get_glyph_v_origin(hb_font_t * font,void * font_data,hb_codepoint_t glyph,hb_position_t * x,hb_position_t * y,void * user_data HB_UNUSED)142 hb_ot_get_glyph_v_origin (hb_font_t *font,
143 void *font_data,
144 hb_codepoint_t glyph,
145 hb_position_t *x,
146 hb_position_t *y,
147 void *user_data HB_UNUSED)
148 {
149 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
150
151 *x = font->get_glyph_h_advance (glyph) / 2;
152
153 #ifndef HB_NO_OT_FONT_CFF
154 const OT::VORG &VORG = *ot_face->VORG;
155 if (VORG.has_data ())
156 {
157 *y = font->em_scale_y (VORG.get_y_origin (glyph));
158 return true;
159 }
160 #endif
161
162 hb_glyph_extents_t extents = {0};
163 if (ot_face->glyf->get_extents (font, glyph, &extents))
164 {
165 const OT::vmtx_accelerator_t &vmtx = *ot_face->vmtx;
166 hb_position_t tsb = vmtx.get_side_bearing (font, glyph);
167 *y = extents.y_bearing + font->em_scale_y (tsb);
168 return true;
169 }
170
171 hb_font_extents_t font_extents;
172 font->get_h_extents_with_fallback (&font_extents);
173 *y = font_extents.ascender;
174
175 return true;
176 }
177
178 static hb_bool_t
hb_ot_get_glyph_extents(hb_font_t * font,void * font_data,hb_codepoint_t glyph,hb_glyph_extents_t * extents,void * user_data HB_UNUSED)179 hb_ot_get_glyph_extents (hb_font_t *font,
180 void *font_data,
181 hb_codepoint_t glyph,
182 hb_glyph_extents_t *extents,
183 void *user_data HB_UNUSED)
184 {
185 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
186 bool ret = false;
187
188 #if !defined(HB_NO_OT_FONT_BITMAP) && !defined(HB_NO_COLOR)
189 if (!ret) ret = ot_face->sbix->get_extents (font, glyph, extents);
190 #endif
191 if (!ret) ret = ot_face->glyf->get_extents (font, glyph, extents);
192 #ifndef HB_NO_OT_FONT_CFF
193 if (!ret) ret = ot_face->cff1->get_extents (font, glyph, extents);
194 if (!ret) ret = ot_face->cff2->get_extents (font, glyph, extents);
195 #endif
196 #if !defined(HB_NO_OT_FONT_BITMAP) && !defined(HB_NO_COLOR)
197 if (!ret) ret = ot_face->CBDT->get_extents (font, glyph, extents);
198 #endif
199
200 // TODO Hook up side-bearings variations.
201 return ret;
202 }
203
204 #ifndef HB_NO_OT_FONT_GLYPH_NAMES
205 static hb_bool_t
hb_ot_get_glyph_name(hb_font_t * font HB_UNUSED,void * font_data,hb_codepoint_t glyph,char * name,unsigned int size,void * user_data HB_UNUSED)206 hb_ot_get_glyph_name (hb_font_t *font HB_UNUSED,
207 void *font_data,
208 hb_codepoint_t glyph,
209 char *name, unsigned int size,
210 void *user_data HB_UNUSED)
211 {
212 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
213 return ot_face->post->get_glyph_name (glyph, name, size);
214 }
215 static hb_bool_t
hb_ot_get_glyph_from_name(hb_font_t * font HB_UNUSED,void * font_data,const char * name,int len,hb_codepoint_t * glyph,void * user_data HB_UNUSED)216 hb_ot_get_glyph_from_name (hb_font_t *font HB_UNUSED,
217 void *font_data,
218 const char *name, int len,
219 hb_codepoint_t *glyph,
220 void *user_data HB_UNUSED)
221 {
222 const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
223 return ot_face->post->get_glyph_from_name (name, len, glyph);
224 }
225 #endif
226
227 static hb_bool_t
hb_ot_get_font_h_extents(hb_font_t * font,void * font_data HB_UNUSED,hb_font_extents_t * metrics,void * user_data HB_UNUSED)228 hb_ot_get_font_h_extents (hb_font_t *font,
229 void *font_data HB_UNUSED,
230 hb_font_extents_t *metrics,
231 void *user_data HB_UNUSED)
232 {
233 return _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER, &metrics->ascender) &&
234 _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER, &metrics->descender) &&
235 _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP, &metrics->line_gap);
236 }
237
238 static hb_bool_t
hb_ot_get_font_v_extents(hb_font_t * font,void * font_data HB_UNUSED,hb_font_extents_t * metrics,void * user_data HB_UNUSED)239 hb_ot_get_font_v_extents (hb_font_t *font,
240 void *font_data HB_UNUSED,
241 hb_font_extents_t *metrics,
242 void *user_data HB_UNUSED)
243 {
244 return _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_VERTICAL_ASCENDER, &metrics->ascender) &&
245 _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_VERTICAL_DESCENDER, &metrics->descender) &&
246 _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_VERTICAL_LINE_GAP, &metrics->line_gap);
247 }
248
249 #if HB_USE_ATEXIT
250 static void free_static_ot_funcs ();
251 #endif
252
253 static struct hb_ot_font_funcs_lazy_loader_t : hb_font_funcs_lazy_loader_t<hb_ot_font_funcs_lazy_loader_t>
254 {
createhb_ot_font_funcs_lazy_loader_t255 static hb_font_funcs_t *create ()
256 {
257 hb_font_funcs_t *funcs = hb_font_funcs_create ();
258
259 hb_font_funcs_set_font_h_extents_func (funcs, hb_ot_get_font_h_extents, nullptr, nullptr);
260 hb_font_funcs_set_font_v_extents_func (funcs, hb_ot_get_font_v_extents, nullptr, nullptr);
261 hb_font_funcs_set_nominal_glyph_func (funcs, hb_ot_get_nominal_glyph, nullptr, nullptr);
262 hb_font_funcs_set_nominal_glyphs_func (funcs, hb_ot_get_nominal_glyphs, nullptr, nullptr);
263 hb_font_funcs_set_variation_glyph_func (funcs, hb_ot_get_variation_glyph, nullptr, nullptr);
264 hb_font_funcs_set_glyph_h_advances_func (funcs, hb_ot_get_glyph_h_advances, nullptr, nullptr);
265 hb_font_funcs_set_glyph_v_advances_func (funcs, hb_ot_get_glyph_v_advances, nullptr, nullptr);
266 //hb_font_funcs_set_glyph_h_origin_func (funcs, hb_ot_get_glyph_h_origin, nullptr, nullptr);
267 hb_font_funcs_set_glyph_v_origin_func (funcs, hb_ot_get_glyph_v_origin, nullptr, nullptr);
268 hb_font_funcs_set_glyph_extents_func (funcs, hb_ot_get_glyph_extents, nullptr, nullptr);
269 //hb_font_funcs_set_glyph_contour_point_func (funcs, hb_ot_get_glyph_contour_point, nullptr, nullptr);
270 #ifndef HB_NO_OT_FONT_GLYPH_NAMES
271 hb_font_funcs_set_glyph_name_func (funcs, hb_ot_get_glyph_name, nullptr, nullptr);
272 hb_font_funcs_set_glyph_from_name_func (funcs, hb_ot_get_glyph_from_name, nullptr, nullptr);
273 #endif
274
275 hb_font_funcs_make_immutable (funcs);
276
277 #if HB_USE_ATEXIT
278 atexit (free_static_ot_funcs);
279 #endif
280
281 return funcs;
282 }
283 } static_ot_funcs;
284
285 #if HB_USE_ATEXIT
286 static
free_static_ot_funcs()287 void free_static_ot_funcs ()
288 {
289 static_ot_funcs.free_instance ();
290 }
291 #endif
292
293 static hb_font_funcs_t *
_hb_ot_get_font_funcs()294 _hb_ot_get_font_funcs ()
295 {
296 return static_ot_funcs.get_unconst ();
297 }
298
299
300 /**
301 * hb_ot_font_set_funcs:
302 *
303 * Since: 0.9.28
304 **/
305 void
hb_ot_font_set_funcs(hb_font_t * font)306 hb_ot_font_set_funcs (hb_font_t *font)
307 {
308 hb_font_set_funcs (font,
309 _hb_ot_get_font_funcs (),
310 &font->face->table,
311 nullptr);
312 }
313
314 #ifndef HB_NO_VAR
315 int
_glyf_get_side_bearing_var(hb_font_t * font,hb_codepoint_t glyph,bool is_vertical)316 _glyf_get_side_bearing_var (hb_font_t *font, hb_codepoint_t glyph, bool is_vertical)
317 {
318 return font->face->table.glyf->get_side_bearing_var (font, glyph, is_vertical);
319 }
320
321 unsigned
_glyf_get_advance_var(hb_font_t * font,hb_codepoint_t glyph,bool is_vertical)322 _glyf_get_advance_var (hb_font_t *font, hb_codepoint_t glyph, bool is_vertical)
323 {
324 return font->face->table.glyf->get_advance_var (font, glyph, is_vertical);
325 }
326 #endif
327
328
329 #endif
330