[FREETYPE]
[reactos.git] / reactos / lib / 3rdparty / freetype / src / truetype / ttdriver.c
1 /***************************************************************************/
2 /* */
3 /* ttdriver.c */
4 /* */
5 /* TrueType font driver implementation (body). */
6 /* */
7 /* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
9 /* */
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. */
15 /* */
16 /***************************************************************************/
17
18
19 #include <ft2build.h>
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
24
25 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
26 #include FT_MULTIPLE_MASTERS_H
27 #include FT_SERVICE_MULTIPLE_MASTERS_H
28 #endif
29
30 #include FT_SERVICE_TRUETYPE_ENGINE_H
31 #include FT_SERVICE_TRUETYPE_GLYF_H
32
33 #include "ttdriver.h"
34 #include "ttgload.h"
35 #include "ttpload.h"
36
37 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
38 #include "ttgxvar.h"
39 #endif
40
41 #include "tterrors.h"
42
43 #include "ttpic.h"
44
45 /*************************************************************************/
46 /* */
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. */
50 /* */
51 #undef FT_COMPONENT
52 #define FT_COMPONENT trace_ttdriver
53
54
55 /*************************************************************************/
56 /*************************************************************************/
57 /*************************************************************************/
58 /**** ****/
59 /**** ****/
60 /**** F A C E S ****/
61 /**** ****/
62 /**** ****/
63 /*************************************************************************/
64 /*************************************************************************/
65 /*************************************************************************/
66
67
68 #undef PAIR_TAG
69 #define PAIR_TAG( left, right ) ( ( (FT_ULong)left << 16 ) | \
70 (FT_ULong)right )
71
72
73 /*************************************************************************/
74 /* */
75 /* <Function> */
76 /* tt_get_kerning */
77 /* */
78 /* <Description> */
79 /* A driver method used to return the kerning vector between two */
80 /* glyphs of the same face. */
81 /* */
82 /* <Input> */
83 /* face :: A handle to the source face object. */
84 /* */
85 /* left_glyph :: The index of the left glyph in the kern pair. */
86 /* */
87 /* right_glyph :: The index of the right glyph in the kern pair. */
88 /* */
89 /* <Output> */
90 /* kerning :: The kerning vector. This is in font units for */
91 /* scalable formats, and in pixels for fixed-sizes */
92 /* formats. */
93 /* */
94 /* <Return> */
95 /* FreeType error code. 0 means success. */
96 /* */
97 /* <Note> */
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). */
102 /* */
103 /* They can be implemented by format-specific interfaces. */
104 /* */
105 static FT_Error
106 tt_get_kerning( FT_Face ttface, /* TT_Face */
107 FT_UInt left_glyph,
108 FT_UInt right_glyph,
109 FT_Vector* kerning )
110 {
111 TT_Face face = (TT_Face)ttface;
112 SFNT_Service sfnt = (SFNT_Service)face->sfnt;
113
114
115 kerning->x = 0;
116 kerning->y = 0;
117
118 if ( sfnt )
119 kerning->x = sfnt->get_kerning( face, left_glyph, right_glyph );
120
121 return 0;
122 }
123
124
125 #undef PAIR_TAG
126
127
128 static FT_Error
129 tt_get_advances( FT_Face ttface,
130 FT_UInt start,
131 FT_UInt count,
132 FT_Int32 flags,
133 FT_Fixed *advances )
134 {
135 FT_UInt nn;
136 TT_Face face = (TT_Face) ttface;
137 FT_Bool check = FT_BOOL(
138 !( flags & FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ) );
139
140
141 /* XXX: TODO: check for sbits */
142
143 if ( flags & FT_LOAD_VERTICAL_LAYOUT )
144 {
145 for ( nn = 0; nn < count; nn++ )
146 {
147 FT_Short tsb;
148 FT_UShort ah;
149
150
151 TT_Get_VMetrics( face, start + nn, check, &tsb, &ah );
152 advances[nn] = ah;
153 }
154 }
155 else
156 {
157 for ( nn = 0; nn < count; nn++ )
158 {
159 FT_Short lsb;
160 FT_UShort aw;
161
162
163 TT_Get_HMetrics( face, start + nn, check, &lsb, &aw );
164 advances[nn] = aw;
165 }
166 }
167
168 return TT_Err_Ok;
169 }
170
171 /*************************************************************************/
172 /*************************************************************************/
173 /*************************************************************************/
174 /**** ****/
175 /**** ****/
176 /**** S I Z E S ****/
177 /**** ****/
178 /**** ****/
179 /*************************************************************************/
180 /*************************************************************************/
181 /*************************************************************************/
182
183
184 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
185
186 static FT_Error
187 tt_size_select( FT_Size size,
188 FT_ULong strike_index )
189 {
190 TT_Face ttface = (TT_Face)size->face;
191 TT_Size ttsize = (TT_Size)size;
192 FT_Error error = TT_Err_Ok;
193
194
195 ttsize->strike_index = strike_index;
196
197 if ( FT_IS_SCALABLE( size->face ) )
198 {
199 /* use the scaled metrics, even when tt_size_reset fails */
200 FT_Select_Metrics( size->face, strike_index );
201
202 tt_size_reset( ttsize );
203 }
204 else
205 {
206 SFNT_Service sfnt = (SFNT_Service) ttface->sfnt;
207 FT_Size_Metrics* metrics = &size->metrics;
208
209
210 error = sfnt->load_strike_metrics( ttface, strike_index, metrics );
211 if ( error )
212 ttsize->strike_index = 0xFFFFFFFFUL;
213 }
214
215 return error;
216 }
217
218 #endif /* TT_CONFIG_OPTION_EMBEDDED_BITMAPS */
219
220
221 static FT_Error
222 tt_size_request( FT_Size size,
223 FT_Size_Request req )
224 {
225 TT_Size ttsize = (TT_Size)size;
226 FT_Error error = TT_Err_Ok;
227
228
229 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
230
231 if ( FT_HAS_FIXED_SIZES( size->face ) )
232 {
233 TT_Face ttface = (TT_Face)size->face;
234 SFNT_Service sfnt = (SFNT_Service) ttface->sfnt;
235 FT_ULong strike_index;
236
237
238 error = sfnt->set_sbit_strike( ttface, req, &strike_index );
239
240 if ( error )
241 ttsize->strike_index = 0xFFFFFFFFUL;
242 else
243 return tt_size_select( size, strike_index );
244 }
245
246 #endif /* TT_CONFIG_OPTION_EMBEDDED_BITMAPS */
247
248 FT_Request_Metrics( size->face, req );
249
250 if ( FT_IS_SCALABLE( size->face ) )
251 error = tt_size_reset( ttsize );
252
253 return error;
254 }
255
256
257 /*************************************************************************/
258 /* */
259 /* <Function> */
260 /* Load_Glyph */
261 /* */
262 /* <Description> */
263 /* A driver method used to load a glyph within a given glyph slot. */
264 /* */
265 /* <Input> */
266 /* slot :: A handle to the target slot object where the glyph */
267 /* will be loaded. */
268 /* */
269 /* size :: A handle to the source face size at which the glyph */
270 /* must be scaled, loaded, etc. */
271 /* */
272 /* glyph_index :: The index of the glyph in the font file. */
273 /* */
274 /* load_flags :: A flag indicating what to load for this glyph. The */
275 /* FT_LOAD_XXX constants can be used to control the */
276 /* glyph loading process (e.g., whether the outline */
277 /* should be scaled, whether to load bitmaps or not, */
278 /* whether to hint the outline, etc). */
279 /* */
280 /* <Return> */
281 /* FreeType error code. 0 means success. */
282 /* */
283 static FT_Error
284 Load_Glyph( FT_GlyphSlot ttslot, /* TT_GlyphSlot */
285 FT_Size ttsize, /* TT_Size */
286 FT_UInt glyph_index,
287 FT_Int32 load_flags )
288 {
289 TT_GlyphSlot slot = (TT_GlyphSlot)ttslot;
290 TT_Size size = (TT_Size)ttsize;
291 FT_Face face = ttslot->face;
292 FT_Error error;
293
294
295 if ( !slot )
296 return TT_Err_Invalid_Slot_Handle;
297
298 if ( !size )
299 return TT_Err_Invalid_Size_Handle;
300
301 if ( !face || glyph_index >= (FT_UInt)face->num_glyphs )
302 return TT_Err_Invalid_Argument;
303
304 if ( load_flags & FT_LOAD_NO_HINTING )
305 {
306 /* both FT_LOAD_NO_HINTING and FT_LOAD_NO_AUTOHINT */
307 /* are necessary to disable hinting for tricky fonts */
308
309 if ( FT_IS_TRICKY( face ) )
310 load_flags &= ~FT_LOAD_NO_HINTING;
311
312 if ( load_flags & FT_LOAD_NO_AUTOHINT )
313 load_flags |= FT_LOAD_NO_HINTING;
314 }
315
316 if ( load_flags & ( FT_LOAD_NO_RECURSE | FT_LOAD_NO_SCALE ) )
317 {
318 load_flags |= FT_LOAD_NO_BITMAP | FT_LOAD_NO_SCALE;
319
320 if ( !FT_IS_TRICKY( face ) )
321 load_flags |= FT_LOAD_NO_HINTING;
322 }
323
324 /* now load the glyph outline if necessary */
325 error = TT_Load_Glyph( size, slot, glyph_index, load_flags );
326
327 /* force drop-out mode to 2 - irrelevant now */
328 /* slot->outline.dropout_mode = 2; */
329
330 return error;
331 }
332
333
334 /*************************************************************************/
335 /*************************************************************************/
336 /*************************************************************************/
337 /**** ****/
338 /**** ****/
339 /**** D R I V E R I N T E R F A C E ****/
340 /**** ****/
341 /**** ****/
342 /*************************************************************************/
343 /*************************************************************************/
344 /*************************************************************************/
345
346 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
347 FT_DEFINE_SERVICE_MULTIMASTERSREC(tt_service_gx_multi_masters,
348 (FT_Get_MM_Func) NULL,
349 (FT_Set_MM_Design_Func) NULL,
350 (FT_Set_MM_Blend_Func) TT_Set_MM_Blend,
351 (FT_Get_MM_Var_Func) TT_Get_MM_Var,
352 (FT_Set_Var_Design_Func)TT_Set_Var_Design
353 )
354 #endif
355
356 static const FT_Service_TrueTypeEngineRec tt_service_truetype_engine =
357 {
358 #ifdef TT_USE_BYTECODE_INTERPRETER
359
360 #ifdef TT_CONFIG_OPTION_UNPATENTED_HINTING
361 FT_TRUETYPE_ENGINE_TYPE_UNPATENTED
362 #else
363 FT_TRUETYPE_ENGINE_TYPE_PATENTED
364 #endif
365
366 #else /* !TT_USE_BYTECODE_INTERPRETER */
367
368 FT_TRUETYPE_ENGINE_TYPE_NONE
369
370 #endif /* TT_USE_BYTECODE_INTERPRETER */
371 };
372
373 FT_DEFINE_SERVICE_TTGLYFREC(tt_service_truetype_glyf,
374 (TT_Glyf_GetLocationFunc)tt_face_get_location
375 )
376
377 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
378 FT_DEFINE_SERVICEDESCREC4(tt_services,
379 FT_SERVICE_ID_XF86_NAME, FT_XF86_FORMAT_TRUETYPE,
380 FT_SERVICE_ID_MULTI_MASTERS, &FT_TT_SERVICE_GX_MULTI_MASTERS_GET,
381 FT_SERVICE_ID_TRUETYPE_ENGINE, &tt_service_truetype_engine,
382 FT_SERVICE_ID_TT_GLYF, &FT_TT_SERVICE_TRUETYPE_GLYF_GET
383 )
384 #else
385 FT_DEFINE_SERVICEDESCREC3(tt_services,
386 FT_SERVICE_ID_XF86_NAME, FT_XF86_FORMAT_TRUETYPE,
387 FT_SERVICE_ID_TRUETYPE_ENGINE, &tt_service_truetype_engine,
388 FT_SERVICE_ID_TT_GLYF, &FT_TT_SERVICE_TRUETYPE_GLYF_GET
389 )
390 #endif
391
392 FT_CALLBACK_DEF( FT_Module_Interface )
393 tt_get_interface( FT_Module driver, /* TT_Driver */
394 const char* tt_interface )
395 {
396 FT_Library library = driver->library;
397 FT_Module_Interface result;
398 FT_Module sfntd;
399 SFNT_Service sfnt;
400 FT_UNUSED(library);
401
402 result = ft_service_list_lookup( FT_TT_SERVICES_GET, tt_interface );
403 if ( result != NULL )
404 return result;
405
406 /* only return the default interface from the SFNT module */
407 sfntd = FT_Get_Module( driver->library, "sfnt" );
408 if ( sfntd )
409 {
410 sfnt = (SFNT_Service)( sfntd->clazz->module_interface );
411 if ( sfnt )
412 return sfnt->get_interface( driver, tt_interface );
413 }
414
415 return 0;
416 }
417
418
419 /* The FT_DriverInterface structure is defined in ftdriver.h. */
420
421 #ifdef TT_USE_BYTECODE_INTERPRETER
422 #define TT_HINTER_FLAG FT_MODULE_DRIVER_HAS_HINTER
423 #else
424 #define TT_HINTER_FLAG 0
425 #endif
426
427 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
428 #define TT_SIZE_SELECT tt_size_select
429 #else
430 #define TT_SIZE_SELECT 0
431 #endif
432
433 FT_DEFINE_DRIVER(tt_driver_class,
434
435
436 FT_MODULE_FONT_DRIVER |
437 FT_MODULE_DRIVER_SCALABLE |
438 TT_HINTER_FLAG,
439
440 sizeof ( TT_DriverRec ),
441
442 "truetype", /* driver name */
443 0x10000L, /* driver version == 1.0 */
444 0x20000L, /* driver requires FreeType 2.0 or above */
445
446 (void*)0, /* driver specific interface */
447
448 tt_driver_init,
449 tt_driver_done,
450 tt_get_interface,
451
452 sizeof ( TT_FaceRec ),
453 sizeof ( TT_SizeRec ),
454 sizeof ( FT_GlyphSlotRec ),
455
456 tt_face_init,
457 tt_face_done,
458 tt_size_init,
459 tt_size_done,
460 tt_slot_init,
461 0, /* FT_Slot_DoneFunc */
462
463 ft_stub_set_char_sizes, /* FT_CONFIG_OPTION_OLD_INTERNALS */
464 ft_stub_set_pixel_sizes, /* FT_CONFIG_OPTION_OLD_INTERNALS */
465
466 Load_Glyph,
467
468 tt_get_kerning,
469 0, /* FT_Face_AttachFunc */
470 tt_get_advances,
471
472 tt_size_request,
473 TT_SIZE_SELECT
474 )
475
476
477 /* END */