1 /***************************************************************************/
5 /* TrueType font driver implementation (body). */
7 /* Copyright 1996-2011 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
16 /***************************************************************************/
20 #include FT_INTERNAL_DEBUG_H
21 #include FT_INTERNAL_STREAM_H
22 #include FT_INTERNAL_SFNT_H
23 #include FT_SERVICE_XFREE86_NAME_H
25 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
26 #include FT_MULTIPLE_MASTERS_H
27 #include FT_SERVICE_MULTIPLE_MASTERS_H
30 #include FT_SERVICE_TRUETYPE_ENGINE_H
31 #include FT_SERVICE_TRUETYPE_GLYF_H
37 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
45 /*************************************************************************/
47 /* The macro FT_COMPONENT is used in trace mode. It is an implicit */
48 /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log */
49 /* messages during execution. */
52 #define FT_COMPONENT trace_ttdriver
55 /*************************************************************************/
56 /*************************************************************************/
57 /*************************************************************************/
63 /*************************************************************************/
64 /*************************************************************************/
65 /*************************************************************************/
69 #define PAIR_TAG( left, right ) ( ( (FT_ULong)left << 16 ) | \
73 /*************************************************************************/
79 /* A driver method used to return the kerning vector between two */
80 /* glyphs of the same face. */
83 /* face :: A handle to the source face object. */
85 /* left_glyph :: The index of the left glyph in the kern pair. */
87 /* right_glyph :: The index of the right glyph in the kern pair. */
90 /* kerning :: The kerning vector. This is in font units for */
91 /* scalable formats, and in pixels for fixed-sizes */
95 /* FreeType error code. 0 means success. */
98 /* Only horizontal layouts (left-to-right & right-to-left) are */
99 /* supported by this function. Other layouts, or more sophisticated */
100 /* kernings, are out of scope of this method (the basic driver */
101 /* interface is meant to be simple). */
103 /* They can be implemented by format-specific interfaces. */
106 tt_get_kerning( FT_Face ttface, /* TT_Face */
111 TT_Face face = (TT_Face)ttface;
112 SFNT_Service sfnt = (SFNT_Service)face->sfnt;
119 kerning->x = sfnt->get_kerning( face, left_glyph, right_glyph );
129 tt_get_advances( FT_Face ttface,
136 TT_Face face = (TT_Face) ttface;
139 /* XXX: TODO: check for sbits */
141 if ( flags & FT_LOAD_VERTICAL_LAYOUT )
143 for ( nn = 0; nn < count; nn++ )
149 TT_Get_VMetrics( face, start + nn, &tsb, &ah );
155 for ( nn = 0; nn < count; nn++ )
161 TT_Get_HMetrics( face, start + nn, &lsb, &aw );
169 /*************************************************************************/
170 /*************************************************************************/
171 /*************************************************************************/
174 /**** S I Z E S ****/
177 /*************************************************************************/
178 /*************************************************************************/
179 /*************************************************************************/
182 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
185 tt_size_select( FT_Size size,
186 FT_ULong strike_index )
188 TT_Face ttface = (TT_Face)size->face;
189 TT_Size ttsize = (TT_Size)size;
190 FT_Error error = TT_Err_Ok;
193 ttsize->strike_index = strike_index;
195 if ( FT_IS_SCALABLE( size->face ) )
197 /* use the scaled metrics, even when tt_size_reset fails */
198 FT_Select_Metrics( size->face, strike_index );
200 tt_size_reset( ttsize );
204 SFNT_Service sfnt = (SFNT_Service) ttface->sfnt;
205 FT_Size_Metrics* metrics = &size->metrics;
208 error = sfnt->load_strike_metrics( ttface, strike_index, metrics );
210 ttsize->strike_index = 0xFFFFFFFFUL;
216 #endif /* TT_CONFIG_OPTION_EMBEDDED_BITMAPS */
220 tt_size_request( FT_Size size,
221 FT_Size_Request req )
223 TT_Size ttsize = (TT_Size)size;
224 FT_Error error = TT_Err_Ok;
227 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
229 if ( FT_HAS_FIXED_SIZES( size->face ) )
231 TT_Face ttface = (TT_Face)size->face;
232 SFNT_Service sfnt = (SFNT_Service) ttface->sfnt;
233 FT_ULong strike_index;
236 error = sfnt->set_sbit_strike( ttface, req, &strike_index );
239 ttsize->strike_index = 0xFFFFFFFFUL;
241 return tt_size_select( size, strike_index );
244 #endif /* TT_CONFIG_OPTION_EMBEDDED_BITMAPS */
246 FT_Request_Metrics( size->face, req );
248 if ( FT_IS_SCALABLE( size->face ) )
249 error = tt_size_reset( ttsize );
255 /*************************************************************************/
261 /* A driver method used to load a glyph within a given glyph slot. */
264 /* slot :: A handle to the target slot object where the glyph */
265 /* will be loaded. */
267 /* size :: A handle to the source face size at which the glyph */
268 /* must be scaled, loaded, etc. */
270 /* glyph_index :: The index of the glyph in the font file. */
272 /* load_flags :: A flag indicating what to load for this glyph. The */
273 /* FT_LOAD_XXX constants can be used to control the */
274 /* glyph loading process (e.g., whether the outline */
275 /* should be scaled, whether to load bitmaps or not, */
276 /* whether to hint the outline, etc). */
279 /* FreeType error code. 0 means success. */
282 Load_Glyph( FT_GlyphSlot ttslot, /* TT_GlyphSlot */
283 FT_Size ttsize, /* TT_Size */
285 FT_Int32 load_flags )
287 TT_GlyphSlot slot = (TT_GlyphSlot)ttslot;
288 TT_Size size = (TT_Size)ttsize;
289 FT_Face face = ttslot->face;
294 return TT_Err_Invalid_Slot_Handle;
297 return TT_Err_Invalid_Size_Handle;
300 return TT_Err_Invalid_Argument;
302 #ifdef FT_CONFIG_OPTION_INCREMENTAL
303 if ( glyph_index >= (FT_UInt)face->num_glyphs &&
304 !face->internal->incremental_interface )
306 if ( glyph_index >= (FT_UInt)face->num_glyphs )
308 return TT_Err_Invalid_Argument;
310 if ( load_flags & FT_LOAD_NO_HINTING )
312 /* both FT_LOAD_NO_HINTING and FT_LOAD_NO_AUTOHINT */
313 /* are necessary to disable hinting for tricky fonts */
315 if ( FT_IS_TRICKY( face ) )
316 load_flags &= ~FT_LOAD_NO_HINTING;
318 if ( load_flags & FT_LOAD_NO_AUTOHINT )
319 load_flags |= FT_LOAD_NO_HINTING;
322 if ( load_flags & ( FT_LOAD_NO_RECURSE | FT_LOAD_NO_SCALE ) )
324 load_flags |= FT_LOAD_NO_BITMAP | FT_LOAD_NO_SCALE;
326 if ( !FT_IS_TRICKY( face ) )
327 load_flags |= FT_LOAD_NO_HINTING;
330 /* now load the glyph outline if necessary */
331 error = TT_Load_Glyph( size, slot, glyph_index, load_flags );
333 /* force drop-out mode to 2 - irrelevant now */
334 /* slot->outline.dropout_mode = 2; */
340 /*************************************************************************/
341 /*************************************************************************/
342 /*************************************************************************/
345 /**** D R I V E R I N T E R F A C E ****/
348 /*************************************************************************/
349 /*************************************************************************/
350 /*************************************************************************/
352 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
353 FT_DEFINE_SERVICE_MULTIMASTERSREC(tt_service_gx_multi_masters,
354 (FT_Get_MM_Func) NULL,
355 (FT_Set_MM_Design_Func) NULL,
356 (FT_Set_MM_Blend_Func) TT_Set_MM_Blend,
357 (FT_Get_MM_Var_Func) TT_Get_MM_Var,
358 (FT_Set_Var_Design_Func)TT_Set_Var_Design
362 static const FT_Service_TrueTypeEngineRec tt_service_truetype_engine =
364 #ifdef TT_USE_BYTECODE_INTERPRETER
366 #ifdef TT_CONFIG_OPTION_UNPATENTED_HINTING
367 FT_TRUETYPE_ENGINE_TYPE_UNPATENTED
369 FT_TRUETYPE_ENGINE_TYPE_PATENTED
372 #else /* !TT_USE_BYTECODE_INTERPRETER */
374 FT_TRUETYPE_ENGINE_TYPE_NONE
376 #endif /* TT_USE_BYTECODE_INTERPRETER */
379 FT_DEFINE_SERVICE_TTGLYFREC(tt_service_truetype_glyf,
380 (TT_Glyf_GetLocationFunc)tt_face_get_location
383 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
384 FT_DEFINE_SERVICEDESCREC4(tt_services,
385 FT_SERVICE_ID_XF86_NAME, FT_XF86_FORMAT_TRUETYPE,
386 FT_SERVICE_ID_MULTI_MASTERS, &FT_TT_SERVICE_GX_MULTI_MASTERS_GET,
387 FT_SERVICE_ID_TRUETYPE_ENGINE, &tt_service_truetype_engine,
388 FT_SERVICE_ID_TT_GLYF, &FT_TT_SERVICE_TRUETYPE_GLYF_GET
391 FT_DEFINE_SERVICEDESCREC3(tt_services,
392 FT_SERVICE_ID_XF86_NAME, FT_XF86_FORMAT_TRUETYPE,
393 FT_SERVICE_ID_TRUETYPE_ENGINE, &tt_service_truetype_engine,
394 FT_SERVICE_ID_TT_GLYF, &FT_TT_SERVICE_TRUETYPE_GLYF_GET
398 FT_CALLBACK_DEF( FT_Module_Interface )
399 tt_get_interface( FT_Module driver, /* TT_Driver */
400 const char* tt_interface )
402 FT_Module_Interface result;
406 result = ft_service_list_lookup( FT_TT_SERVICES_GET, tt_interface );
407 if ( result != NULL )
413 /* only return the default interface from the SFNT module */
414 sfntd = FT_Get_Module( driver->library, "sfnt" );
417 sfnt = (SFNT_Service)( sfntd->clazz->module_interface );
419 return sfnt->get_interface( driver, tt_interface );
426 /* The FT_DriverInterface structure is defined in ftdriver.h. */
428 #ifdef TT_USE_BYTECODE_INTERPRETER
429 #define TT_HINTER_FLAG FT_MODULE_DRIVER_HAS_HINTER
431 #define TT_HINTER_FLAG 0
434 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
435 #define TT_SIZE_SELECT tt_size_select
437 #define TT_SIZE_SELECT 0
440 FT_DEFINE_DRIVER(tt_driver_class,
443 FT_MODULE_FONT_DRIVER |
444 FT_MODULE_DRIVER_SCALABLE |
447 sizeof ( TT_DriverRec ),
449 "truetype", /* driver name */
450 0x10000L, /* driver version == 1.0 */
451 0x20000L, /* driver requires FreeType 2.0 or above */
453 (void*)0, /* driver specific interface */
459 sizeof ( TT_FaceRec ),
460 sizeof ( TT_SizeRec ),
461 sizeof ( FT_GlyphSlotRec ),
468 0, /* FT_Slot_DoneFunc */
470 ft_stub_set_char_sizes, /* FT_CONFIG_OPTION_OLD_INTERNALS */
471 ft_stub_set_pixel_sizes, /* FT_CONFIG_OPTION_OLD_INTERNALS */
476 0, /* FT_Face_AttachFunc */