Visualization Library 2.0.0-b5

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
ttdriver.c
Go to the documentation of this file.
1 /***************************************************************************/
2 /* */
3 /* ttdriver.c */
4 /* */
5 /* TrueType font driver implementation (body). */
6 /* */
7 /* Copyright 1996-2013 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 
138 
139  /* XXX: TODO: check for sbits */
140 
142  {
143  for ( nn = 0; nn < count; nn++ )
144  {
145  FT_Short tsb;
146  FT_UShort ah;
147 
148 
149  TT_Get_VMetrics( face, start + nn, &tsb, &ah );
150  advances[nn] = ah;
151  }
152  }
153  else
154  {
155  for ( nn = 0; nn < count; nn++ )
156  {
157  FT_Short lsb;
158  FT_UShort aw;
159 
160 
161  TT_Get_HMetrics( face, start + nn, &lsb, &aw );
162  advances[nn] = aw;
163  }
164  }
165 
166  return FT_Err_Ok;
167  }
168 
169  /*************************************************************************/
170  /*************************************************************************/
171  /*************************************************************************/
172  /**** ****/
173  /**** ****/
174  /**** S I Z E S ****/
175  /**** ****/
176  /**** ****/
177  /*************************************************************************/
178  /*************************************************************************/
179  /*************************************************************************/
180 
181 
182 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
183 
184  static FT_Error
185  tt_size_select( FT_Size size,
186  FT_ULong strike_index )
187  {
188  TT_Face ttface = (TT_Face)size->face;
189  TT_Size ttsize = (TT_Size)size;
191 
192 
193  ttsize->strike_index = strike_index;
194 
195  if ( FT_IS_SCALABLE( size->face ) )
196  {
197  /* use the scaled metrics, even when tt_size_reset fails */
198  FT_Select_Metrics( size->face, strike_index );
199 
200  tt_size_reset( ttsize );
201  }
202  else
203  {
204  SFNT_Service sfnt = (SFNT_Service) ttface->sfnt;
205  FT_Size_Metrics* metrics = &size->metrics;
206 
207 
208  error = sfnt->load_strike_metrics( ttface, strike_index, metrics );
209  if ( error )
210  ttsize->strike_index = 0xFFFFFFFFUL;
211  }
212 
213  return error;
214  }
215 
216 #endif /* TT_CONFIG_OPTION_EMBEDDED_BITMAPS */
217 
218 
219  static FT_Error
220  tt_size_request( FT_Size size,
221  FT_Size_Request req )
222  {
223  TT_Size ttsize = (TT_Size)size;
225 
226 
227 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
228 
229  if ( FT_HAS_FIXED_SIZES( size->face ) )
230  {
231  TT_Face ttface = (TT_Face)size->face;
232  SFNT_Service sfnt = (SFNT_Service) ttface->sfnt;
233  FT_ULong strike_index;
234 
235 
236  error = sfnt->set_sbit_strike( ttface, req, &strike_index );
237 
238  if ( error )
239  ttsize->strike_index = 0xFFFFFFFFUL;
240  else
241  return tt_size_select( size, strike_index );
242  }
243 
244 #endif /* TT_CONFIG_OPTION_EMBEDDED_BITMAPS */
245 
246  FT_Request_Metrics( size->face, req );
247 
248  if ( FT_IS_SCALABLE( size->face ) )
249  {
250  error = tt_size_reset( ttsize );
251  ttsize->root.metrics = ttsize->metrics;
252  }
253 
254  return error;
255  }
256 
257 
258  /*************************************************************************/
259  /* */
260  /* <Function> */
261  /* tt_glyph_load */
262  /* */
263  /* <Description> */
264  /* A driver method used to load a glyph within a given glyph slot. */
265  /* */
266  /* <Input> */
267  /* slot :: A handle to the target slot object where the glyph */
268  /* will be loaded. */
269  /* */
270  /* size :: A handle to the source face size at which the glyph */
271  /* must be scaled, loaded, etc. */
272  /* */
273  /* glyph_index :: The index of the glyph in the font file. */
274  /* */
275  /* load_flags :: A flag indicating what to load for this glyph. The */
276  /* FT_LOAD_XXX constants can be used to control the */
277  /* glyph loading process (e.g., whether the outline */
278  /* should be scaled, whether to load bitmaps or not, */
279  /* whether to hint the outline, etc). */
280  /* */
281  /* <Return> */
282  /* FreeType error code. 0 means success. */
283  /* */
284  static FT_Error
285  tt_glyph_load( FT_GlyphSlot ttslot, /* TT_GlyphSlot */
286  FT_Size ttsize, /* TT_Size */
287  FT_UInt glyph_index,
288  FT_Int32 load_flags )
289  {
290  TT_GlyphSlot slot = (TT_GlyphSlot)ttslot;
291  TT_Size size = (TT_Size)ttsize;
292  FT_Face face = ttslot->face;
293  FT_Error error;
294 
295 
296  if ( !slot )
297  return FT_THROW( Invalid_Slot_Handle );
298 
299  if ( !size )
300  return FT_THROW( Invalid_Size_Handle );
301 
302  if ( !face )
303  return FT_THROW( Invalid_Argument );
304 
305 #ifdef FT_CONFIG_OPTION_INCREMENTAL
306  if ( glyph_index >= (FT_UInt)face->num_glyphs &&
307  !face->internal->incremental_interface )
308 #else
309  if ( glyph_index >= (FT_UInt)face->num_glyphs )
310 #endif
311  return FT_THROW( Invalid_Argument );
312 
313  if ( load_flags & FT_LOAD_NO_HINTING )
314  {
315  /* both FT_LOAD_NO_HINTING and FT_LOAD_NO_AUTOHINT */
316  /* are necessary to disable hinting for tricky fonts */
317 
318  if ( FT_IS_TRICKY( face ) )
319  load_flags &= ~FT_LOAD_NO_HINTING;
320 
321  if ( load_flags & FT_LOAD_NO_AUTOHINT )
322  load_flags |= FT_LOAD_NO_HINTING;
323  }
324 
325  if ( load_flags & ( FT_LOAD_NO_RECURSE | FT_LOAD_NO_SCALE ) )
326  {
327  load_flags |= FT_LOAD_NO_BITMAP | FT_LOAD_NO_SCALE;
328 
329  if ( !FT_IS_TRICKY( face ) )
330  load_flags |= FT_LOAD_NO_HINTING;
331  }
332 
333  /* now load the glyph outline if necessary */
334  error = TT_Load_Glyph( size, slot, glyph_index, load_flags );
335 
336  /* force drop-out mode to 2 - irrelevant now */
337  /* slot->outline.dropout_mode = 2; */
338 
339  return error;
340  }
341 
342 
343  /*************************************************************************/
344  /*************************************************************************/
345  /*************************************************************************/
346  /**** ****/
347  /**** ****/
348  /**** D R I V E R I N T E R F A C E ****/
349  /**** ****/
350  /**** ****/
351  /*************************************************************************/
352  /*************************************************************************/
353  /*************************************************************************/
354 
355 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
357  tt_service_gx_multi_masters,
363 #endif
364 
365  static const FT_Service_TrueTypeEngineRec tt_service_truetype_engine =
366  {
367 #ifdef TT_USE_BYTECODE_INTERPRETER
368 
369 #ifdef TT_CONFIG_OPTION_UNPATENTED_HINTING
371 #else
373 #endif
374 
375 #else /* !TT_USE_BYTECODE_INTERPRETER */
376 
378 
379 #endif /* TT_USE_BYTECODE_INTERPRETER */
380  };
381 
383  tt_service_truetype_glyf,
385 
386 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
388  tt_services,
391  FT_SERVICE_ID_TRUETYPE_ENGINE, &tt_service_truetype_engine,
393 #else
395  tt_services,
397  FT_SERVICE_ID_TRUETYPE_ENGINE, &tt_service_truetype_engine,
399 #endif
400 
401 
404  const char* tt_interface )
405  {
408  FT_Module sfntd;
409  SFNT_Service sfnt;
410 
411 
412  /* TT_SERVICES_GET derefers `library' in PIC mode */
413 #ifdef FT_CONFIG_OPTION_PIC
414  if ( !driver )
415  return NULL;
416  library = driver->library;
417  if ( !library )
418  return NULL;
419 #endif
420 
421  result = ft_service_list_lookup( TT_SERVICES_GET, tt_interface );
422  if ( result != NULL )
423  return result;
424 
425 #ifndef FT_CONFIG_OPTION_PIC
426  if ( !driver )
427  return NULL;
428  library = driver->library;
429  if ( !library )
430  return NULL;
431 #endif
432 
433  /* only return the default interface from the SFNT module */
434  sfntd = FT_Get_Module( library, "sfnt" );
435  if ( sfntd )
436  {
437  sfnt = (SFNT_Service)( sfntd->clazz->module_interface );
438  if ( sfnt )
439  return sfnt->get_interface( driver, tt_interface );
440  }
441 
442  return 0;
443  }
444 
445 
446  /* The FT_DriverInterface structure is defined in ftdriver.h. */
447 
448 #ifdef TT_USE_BYTECODE_INTERPRETER
449 #define TT_HINTER_FLAG FT_MODULE_DRIVER_HAS_HINTER
450 #else
451 #define TT_HINTER_FLAG 0
452 #endif
453 
454 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
455 #define TT_SIZE_SELECT tt_size_select
456 #else
457 #define TT_SIZE_SELECT 0
458 #endif
459 
460  FT_DEFINE_DRIVER( tt_driver_class,
461 
465 
466  sizeof ( TT_DriverRec ),
467 
468  "truetype", /* driver name */
469  0x10000L, /* driver version == 1.0 */
470  0x20000L, /* driver requires FreeType 2.0 or above */
471 
472  (void*)0, /* driver specific interface */
473 
477 
478  sizeof ( TT_FaceRec ),
479  sizeof ( TT_SizeRec ),
480  sizeof ( FT_GlyphSlotRec ),
481 
482  tt_face_init,
483  tt_face_done,
484  tt_size_init,
485  tt_size_done,
486  tt_slot_init,
487  0, /* FT_Slot_DoneFunc */
488 
489  ft_stub_set_char_sizes, /* FT_CONFIG_OPTION_OLD_INTERNALS */
490  ft_stub_set_pixel_sizes, /* FT_CONFIG_OPTION_OLD_INTERNALS */
491 
492  tt_glyph_load,
493 
494  tt_get_kerning,
495  0, /* FT_Face_AttachFunc */
496  tt_get_advances,
497 
498  tt_size_request,
500  )
501 
502 
503 /* END */
#define FT_SERVICE_ID_MULTI_MASTERS
Definition: svmm.h:35
FT_Face face
Definition: freetype.h:1404
ft_service_list_lookup(FT_ServiceDesc service_descriptors, const char *service_id)
Definition: ftobjs.c:58
int FT_Error
Definition: fttypes.h:296
#define FT_LOAD_VERTICAL_LAYOUT
Definition: freetype.h:2553
void * sfnt
Definition: tttypes.h:1298
TT_Load_Strike_Metrics_Func load_strike_metrics
Definition: sfnt.h:746
SFNT_Interface * SFNT_Service
Definition: sfnt.h:754
unsigned long FT_ULong
Definition: fttypes.h:249
tt_size_done(FT_Size ttsize)
Definition: ttobjs.c:1139
#define TT_HINTER_FLAG
Definition: ttdriver.c:451
FT_SERVICE_ID_TRUETYPE_ENGINE
Definition: ttdriver.c:396
FT_Select_Metrics(FT_Face face, FT_ULong strike_index)
Definition: ftobjs.c:2602
#define NULL
Definition: ftobjs.h:61
FT_ULong strike_index
Definition: ttobjs.h:300
FT_Error(* FT_Set_MM_Design_Func)(FT_Face face, FT_UInt num_coords, FT_Long *coords)
Definition: svmm.h:47
FT_XF86_FORMAT_TRUETYPE
Definition: ttdriver.c:396
FT_Module_Class * clazz
Definition: ftobjs.h:475
#define FT_LOAD_NO_HINTING
Definition: freetype.h:2550
return FT_THROW(Missing_Property)
tt_slot_init(FT_GlyphSlot slot)
Definition: ttobjs.c:1318
#define FT_LOAD_NO_RECURSE
Definition: freetype.h:2558
GLuint start
FT_Library library
Definition: cffdrivr.c:414
#define FT_MODULE_DRIVER_SCALABLE
Definition: ftmodapi.h:87
tt_size_init(FT_Size ttsize)
Definition: ttobjs.c:1110
return FT_Err_Ok
Definition: ftbbox.c:645
#define FT_DEFINE_SERVICEDESCREC4(class_, serv_id_1, serv_data_1, serv_id_2, serv_data_2, serv_id_3, serv_data_3, serv_id_4, serv_data_4)
Definition: ftserv.h:226
#define TT_SERVICE_TRUETYPE_GLYF_GET
Definition: ttpic.h:29
#define TT_SIZE_SELECT
Definition: ttdriver.c:457
FT_ULong(* TT_Glyf_GetLocationFunc)(FT_Face face, FT_UInt gindex, FT_ULong *psize)
Definition: svttglyf.h:31
#define FT_LOAD_NO_SCALE
Definition: freetype.h:2549
FT_Face_Internal internal
Definition: freetype.h:971
FT_GlyphSlot TT_GlyphSlot
Definition: ttobjs.h:65
tt_face_init(FT_Stream stream, FT_Face ttface, FT_Int face_index, FT_Int num_params, FT_Parameter *params)
Definition: ttobjs.c:504
GLenum GLuint GLint GLenum face
#define const
Definition: zconf.h:91
FT_SERVICE_ID_TT_GLYF
Definition: ttdriver.c:396
tt_size_reset(TT_Size size)
Definition: ttobjs.c:1166
#define FT_DEFINE_DRIVER( class_, flags_, size_, name_, version_, requires_, interface_, init_, done_, get_interface_, face_object_size_, size_object_size_, slot_object_size_, init_face_, done_face_, init_size_, done_size_, init_slot_, done_slot_, old_set_char_sizes_, old_set_pixel_sizes_, load_glyph_, get_kerning_, attach_file_, get_advances_, request_size_, select_size_)
Definition: ftdriver.h:293
TT_Get_MM_Var(TT_Face face, FT_MM_Var **master)
FT_SizeRec root
Definition: ttobjs.h:292
#define TT_SERVICES_GET
Definition: ttpic.h:27
TT_Get_VMetrics(TT_Face face, FT_UInt idx, FT_Short *tsb, FT_UShort *ah)
Definition: ttgload.c:95
struct TT_FaceRec_ * TT_Face
Definition: tttypes.h:951
TT_CMap_Info_GetFunc tt_get_cmap_info FT_DEFINE_SERVICEDESCREC3(sfnt_services, FT_SERVICE_ID_SFNT_TABLE, &SFNT_SERVICE_SFNT_TABLE_GET, FT_SERVICE_ID_POSTSCRIPT_FONT_NAME, &SFNT_SERVICE_PS_NAME_GET, FT_SERVICE_ID_TT_CMAP, &TT_SERVICE_CMAP_INFO_GET) sfnt_get_interface(FT_Module module
FT_Request_Metrics(FT_Face face, FT_Size_Request req)
Definition: ftobjs.c:2649
TT_Face_GetKerningFunc get_kerning
Definition: sfnt.h:733
FT_Error error
Definition: cffdrivr.c:411
FT_Pos x
Definition: ftimage.h:77
TT_Get_HMetrics(TT_Face face, FT_UInt idx, FT_Short *lsb, FT_UShort *aw)
Definition: ttgload.c:72
#define FT_HAS_FIXED_SIZES(face)
Definition: freetype.h:1197
GLbitfield flags
tt_driver_done(FT_Module ttdriver)
Definition: ttobjs.c:1284
#define FT_IS_TRICKY(face)
Definition: freetype.h:1270
FT_Pos y
Definition: ftimage.h:78
FT_Pointer FT_Module_Interface
Definition: ftmodapi.h:106
&TT_SERVICE_TRUETYPE_GLYF_GET tt_get_interface(FT_Module driver, const char *tt_interface)
Definition: ttdriver.c:403
const void * module_interface
Definition: ftmodapi.h:194
FT_Error(* FT_Set_Var_Design_Func)(FT_Face face, FT_UInt num_coords, FT_Fixed *coords)
Definition: svmm.h:52
TT_Set_MM_Blend(TT_Face face, FT_UInt num_coords, FT_Fixed *coords)
signed int FT_Int32
Definition: ftconfig.h:132
#define FT_CALLBACK_DEF(x)
Definition: ftconfig.h:323
#define FT_DEFINE_SERVICE_MULTIMASTERSREC(class_, get_mm_, set_mm_design_, set_mm_blend_, get_mm_var_, set_var_design_)
Definition: svmm.h:74
FT_SERVICE_ID_XF86_NAME
Definition: ttdriver.c:396
FT_Error(* FT_Set_MM_Blend_Func)(FT_Face face, FT_UInt num_coords, FT_Long *coords)
Definition: svmm.h:57
#define FT_MODULE_FONT_DRIVER
Definition: ftmodapi.h:82
TT_Set_Var_Design(TT_Face face, FT_UInt num_coords, FT_Fixed *coords)
signed short FT_Short
Definition: fttypes.h:194
tt_face_done(FT_Face ttface)
Definition: ttobjs.c:671
CFF_Driver driver
Definition: cffdrivr.c:585
if(!abbox) return FT_THROW(Invalid_Argument)
signed long FT_Fixed
Definition: fttypes.h:284
FT_Long num_glyphs
Definition: freetype.h:927
FT_DEFINE_SERVICE_TTGLYFREC(tt_service_truetype_glyf,(TT_Glyf_GetLocationFunc) tt_face_get_location) FT_DEFINE_SERVICEDESCREC3(tt_services
GLuint64EXT * result
FT_Module_Requester get_interface
Definition: sfnt.h:656
unsigned int FT_UInt
Definition: fttypes.h:227
FT_Error(* FT_Get_MM_Func)(FT_Face face, FT_Multi_Master *master)
Definition: svmm.h:39
tt_driver_init(FT_Module ttdriver)
Definition: ttobjs.c:1251
#define FT_LOAD_NO_AUTOHINT
Definition: freetype.h:2562
FT_Get_Module(FT_Library library, const char *module_name)
Definition: ftobjs.c:4309
GLuint GLuint GLsizei count
#define TT_SERVICE_GX_MULTI_MASTERS_GET
Definition: ttpic.h:28
GLsizei GLenum const GLvoid GLuint GLsizei GLfloat * metrics
#define FT_LOAD_NO_BITMAP
Definition: freetype.h:2552
TT_Load_Glyph(TT_Size size, TT_GlyphSlot glyph, FT_UInt glyph_index, FT_Int32 load_flags)
Definition: ttgload.c:2139
unsigned short FT_UShort
Definition: fttypes.h:205
#define FT_IS_SCALABLE(face)
Definition: freetype.h:1148
GLsizeiptr size
FT_Error(* FT_Get_MM_Var_Func)(FT_Face face, FT_MM_Var **master)
Definition: svmm.h:43
struct TT_SizeRec_ * TT_Size
Definition: ttobjs.h:50
FT_Size_Metrics metrics
Definition: freetype.h:1406
tt_face_get_location(TT_Face face, FT_UInt gindex, FT_UInt *asize)
Definition: ttpload.c:173
FT_Size_Metrics metrics
Definition: ttobjs.h:296