1
/***************************************************************************/
5
/* The FreeType private base classes (specification). */
7
/* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2008, 2010 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
/***************************************************************************/
19
/*************************************************************************/
21
/* This file contains the definition of all internal FreeType classes. */
23
/*************************************************************************/
32
#include FT_LCD_FILTER_H
33
#include FT_INTERNAL_MEMORY_H
34
#include FT_INTERNAL_GLYPH_LOADER_H
35
#include FT_INTERNAL_DRIVER_H
36
#include FT_INTERNAL_AUTOHINT_H
37
#include FT_INTERNAL_SERVICE_H
38
#include FT_INTERNAL_PIC_H
40
#ifdef FT_CONFIG_OPTION_INCREMENTAL
41
#include FT_INCREMENTAL_H
48
/*************************************************************************/
50
/* Some generic definitions. */
65
/*************************************************************************/
67
/* The min and max functions missing in C. As usual, be careful not to */
68
/* write things like FT_MIN( a++, b++ ) to avoid side effects. */
70
#define FT_MIN( a, b ) ( (a) < (b) ? (a) : (b) )
71
#define FT_MAX( a, b ) ( (a) > (b) ? (a) : (b) )
73
#define FT_ABS( a ) ( (a) < 0 ? -(a) : (a) )
76
#define FT_PAD_FLOOR( x, n ) ( (x) & ~((n)-1) )
77
#define FT_PAD_ROUND( x, n ) FT_PAD_FLOOR( (x) + ((n)/2), n )
78
#define FT_PAD_CEIL( x, n ) FT_PAD_FLOOR( (x) + ((n)-1), n )
80
#define FT_PIX_FLOOR( x ) ( (x) & ~63 )
81
#define FT_PIX_ROUND( x ) FT_PIX_FLOOR( (x) + 32 )
82
#define FT_PIX_CEIL( x ) FT_PIX_FLOOR( (x) + 63 )
86
* Return the highest power of 2 that is <= value; this correspond to
87
* the highest bit in a given 32-bit value.
90
ft_highpow2( FT_UInt32 value );
94
* character classification functions -- since these are used to parse
95
* font files, we must not use those in <ctypes.h> which are
98
#define ft_isdigit( x ) ( ( (unsigned)(x) - '0' ) < 10U )
100
#define ft_isxdigit( x ) ( ( (unsigned)(x) - '0' ) < 10U || \
101
( (unsigned)(x) - 'a' ) < 6U || \
102
( (unsigned)(x) - 'A' ) < 6U )
104
/* the next two macros assume ASCII representation */
105
#define ft_isupper( x ) ( ( (unsigned)(x) - 'A' ) < 26U )
106
#define ft_islower( x ) ( ( (unsigned)(x) - 'a' ) < 26U )
108
#define ft_isalpha( x ) ( ft_isupper( x ) || ft_islower( x ) )
109
#define ft_isalnum( x ) ( ft_isdigit( x ) || ft_isalpha( x ) )
112
/*************************************************************************/
113
/*************************************************************************/
114
/*************************************************************************/
117
/**** C H A R M A P S ****/
120
/*************************************************************************/
121
/*************************************************************************/
122
/*************************************************************************/
124
/* handle to internal charmap object */
125
typedef struct FT_CMapRec_* FT_CMap;
127
/* handle to charmap class structure */
128
typedef const struct FT_CMap_ClassRec_* FT_CMap_Class;
130
/* internal charmap object structure */
131
typedef struct FT_CMapRec_
133
FT_CharMapRec charmap;
138
/* typecase any pointer to a charmap handle */
139
#define FT_CMAP( x ) ((FT_CMap)( x ))
142
#define FT_CMAP_PLATFORM_ID( x ) FT_CMAP( x )->charmap.platform_id
143
#define FT_CMAP_ENCODING_ID( x ) FT_CMAP( x )->charmap.encoding_id
144
#define FT_CMAP_ENCODING( x ) FT_CMAP( x )->charmap.encoding
145
#define FT_CMAP_FACE( x ) FT_CMAP( x )->charmap.face
148
/* class method definitions */
150
(*FT_CMap_InitFunc)( FT_CMap cmap,
151
FT_Pointer init_data );
154
(*FT_CMap_DoneFunc)( FT_CMap cmap );
157
(*FT_CMap_CharIndexFunc)( FT_CMap cmap,
158
FT_UInt32 char_code );
161
(*FT_CMap_CharNextFunc)( FT_CMap cmap,
162
FT_UInt32 *achar_code );
165
(*FT_CMap_CharVarIndexFunc)( FT_CMap cmap,
166
FT_CMap unicode_cmap,
168
FT_UInt32 variant_selector );
171
(*FT_CMap_CharVarIsDefaultFunc)( FT_CMap cmap,
173
FT_UInt32 variant_selector );
176
(*FT_CMap_VariantListFunc)( FT_CMap cmap,
180
(*FT_CMap_CharVariantListFunc)( FT_CMap cmap,
182
FT_UInt32 char_code );
185
(*FT_CMap_VariantCharListFunc)( FT_CMap cmap,
187
FT_UInt32 variant_selector );
190
typedef struct FT_CMap_ClassRec_
193
FT_CMap_InitFunc init;
194
FT_CMap_DoneFunc done;
195
FT_CMap_CharIndexFunc char_index;
196
FT_CMap_CharNextFunc char_next;
198
/* Subsequent entries are special ones for format 14 -- the variant */
199
/* selector subtable which behaves like no other */
201
FT_CMap_CharVarIndexFunc char_var_index;
202
FT_CMap_CharVarIsDefaultFunc char_var_default;
203
FT_CMap_VariantListFunc variant_list;
204
FT_CMap_CharVariantListFunc charvariant_list;
205
FT_CMap_VariantCharListFunc variantchar_list;
209
#ifndef FT_CONFIG_OPTION_PIC
211
#define FT_DECLARE_CMAP_CLASS(class_) \
212
FT_CALLBACK_TABLE const FT_CMap_ClassRec class_;
214
#define FT_DEFINE_CMAP_CLASS(class_, size_, init_, done_, char_index_, \
215
char_next_, char_var_index_, char_var_default_, variant_list_, \
216
charvariant_list_, variantchar_list_) \
217
FT_CALLBACK_TABLE_DEF \
218
const FT_CMap_ClassRec class_ = \
220
size_, init_, done_, char_index_, char_next_, char_var_index_, \
221
char_var_default_, variant_list_, charvariant_list_, variantchar_list_ \
223
#else /* FT_CONFIG_OPTION_PIC */
225
#define FT_DECLARE_CMAP_CLASS(class_) \
226
void FT_Init_Class_##class_( FT_Library library, FT_CMap_ClassRec* clazz);
228
#define FT_DEFINE_CMAP_CLASS(class_, size_, init_, done_, char_index_, \
229
char_next_, char_var_index_, char_var_default_, variant_list_, \
230
charvariant_list_, variantchar_list_) \
232
FT_Init_Class_##class_( FT_Library library, \
233
FT_CMap_ClassRec* clazz) \
235
FT_UNUSED(library); \
236
clazz->size = size_; \
237
clazz->init = init_; \
238
clazz->done = done_; \
239
clazz->char_index = char_index_; \
240
clazz->char_next = char_next_; \
241
clazz->char_var_index = char_var_index_; \
242
clazz->char_var_default = char_var_default_; \
243
clazz->variant_list = variant_list_; \
244
clazz->charvariant_list = charvariant_list_; \
245
clazz->variantchar_list = variantchar_list_; \
247
#endif /* FT_CONFIG_OPTION_PIC */
249
/* create a new charmap and add it to charmap->face */
251
FT_CMap_New( FT_CMap_Class clazz,
252
FT_Pointer init_data,
256
/* destroy a charmap and remove it from face's list */
258
FT_CMap_Done( FT_CMap cmap );
261
/*************************************************************************/
264
/* FT_Face_InternalRec */
267
/* This structure contains the internal fields of each FT_Face */
268
/* object. These fields may change between different releases of */
273
/* The maximal number of points used to store the vectorial outline */
274
/* of any glyph in this face. If this value cannot be known in */
275
/* advance, or if the face isn't scalable, this should be set to 0. */
276
/* Only relevant for scalable formats. */
278
/* max_contours :: */
279
/* The maximal number of contours used to store the vectorial */
280
/* outline of any glyph in this face. If this value cannot be */
281
/* known in advance, or if the face isn't scalable, this should be */
282
/* set to 0. Only relevant for scalable formats. */
284
/* transform_matrix :: */
285
/* A 2x2 matrix of 16.16 coefficients used to transform glyph */
286
/* outlines after they are loaded from the font. Only used by the */
287
/* convenience functions. */
289
/* transform_delta :: */
290
/* A translation vector used to transform glyph outlines after they */
291
/* are loaded from the font. Only used by the convenience */
294
/* transform_flags :: */
295
/* Some flags used to classify the transform. Only used by the */
296
/* convenience functions. */
299
/* A cache for frequently used services. It should be only */
300
/* accessed with the macro `FT_FACE_LOOKUP_SERVICE'. */
302
/* incremental_interface :: */
303
/* If non-null, the interface through which glyph data and metrics */
304
/* are loaded incrementally for faces that do not provide all of */
305
/* this data when first opened. This field exists only if */
306
/* @FT_CONFIG_OPTION_INCREMENTAL is defined. */
308
/* ignore_unpatented_hinter :: */
309
/* This boolean flag instructs the glyph loader to ignore the */
310
/* native font hinter, if one is found. This is exclusively used */
311
/* in the case when the unpatented hinter is compiled within the */
315
/* A counter initialized to~1 at the time an @FT_Face structure is */
316
/* created. @FT_Reference_Face increments this counter, and */
317
/* @FT_Done_Face only destroys a face if the counter is~1, */
318
/* otherwise it simply decrements it. */
320
typedef struct FT_Face_InternalRec_
322
#ifdef FT_CONFIG_OPTION_OLD_INTERNALS
326
FT_Matrix transform_matrix;
327
FT_Vector transform_delta;
328
FT_Int transform_flags;
330
FT_ServiceCacheRec services;
332
#ifdef FT_CONFIG_OPTION_INCREMENTAL
333
FT_Incremental_InterfaceRec* incremental_interface;
336
FT_Bool ignore_unpatented_hinter;
339
} FT_Face_InternalRec;
342
/*************************************************************************/
345
/* FT_Slot_InternalRec */
348
/* This structure contains the internal fields of each FT_GlyphSlot */
349
/* object. These fields may change between different releases of */
353
/* loader :: The glyph loader object used to load outlines */
354
/* into the glyph slot. */
356
/* flags :: Possible values are zero or */
357
/* FT_GLYPH_OWN_BITMAP. The latter indicates */
358
/* that the FT_GlyphSlot structure owns the */
361
/* glyph_transformed :: Boolean. Set to TRUE when the loaded glyph */
362
/* must be transformed through a specific */
363
/* font transformation. This is _not_ the same */
364
/* as the face transform set through */
365
/* FT_Set_Transform(). */
367
/* glyph_matrix :: The 2x2 matrix corresponding to the glyph */
368
/* transformation, if necessary. */
370
/* glyph_delta :: The 2d translation vector corresponding to */
371
/* the glyph transformation, if necessary. */
373
/* glyph_hints :: Format-specific glyph hints management. */
376
#define FT_GLYPH_OWN_BITMAP 0x1
378
typedef struct FT_Slot_InternalRec_
380
FT_GlyphLoader loader;
382
FT_Bool glyph_transformed;
383
FT_Matrix glyph_matrix;
384
FT_Vector glyph_delta;
387
} FT_GlyphSlot_InternalRec;
392
/*************************************************************************/
395
/* FT_Size_InternalRec */
398
/* This structure contains the internal fields of each FT_Size */
399
/* object. Currently, it's empty. */
401
/*************************************************************************/
403
typedef struct FT_Size_InternalRec_
407
} FT_Size_InternalRec;
412
/*************************************************************************/
413
/*************************************************************************/
416
/**** M O D U L E S ****/
419
/*************************************************************************/
420
/*************************************************************************/
421
/*************************************************************************/
424
/*************************************************************************/
430
/* A module object instance. */
433
/* clazz :: A pointer to the module's class. */
435
/* library :: A handle to the parent library object. */
437
/* memory :: A handle to the memory manager. */
439
/* generic :: A generic structure for user-level extensibility (?). */
441
typedef struct FT_ModuleRec_
443
FT_Module_Class* clazz;
451
/* typecast an object to a FT_Module */
452
#define FT_MODULE( x ) ((FT_Module)( x ))
453
#define FT_MODULE_CLASS( x ) FT_MODULE( x )->clazz
454
#define FT_MODULE_LIBRARY( x ) FT_MODULE( x )->library
455
#define FT_MODULE_MEMORY( x ) FT_MODULE( x )->memory
458
#define FT_MODULE_IS_DRIVER( x ) ( FT_MODULE_CLASS( x )->module_flags & \
459
FT_MODULE_FONT_DRIVER )
461
#define FT_MODULE_IS_RENDERER( x ) ( FT_MODULE_CLASS( x )->module_flags & \
464
#define FT_MODULE_IS_HINTER( x ) ( FT_MODULE_CLASS( x )->module_flags & \
467
#define FT_MODULE_IS_STYLER( x ) ( FT_MODULE_CLASS( x )->module_flags & \
470
#define FT_DRIVER_IS_SCALABLE( x ) ( FT_MODULE_CLASS( x )->module_flags & \
471
FT_MODULE_DRIVER_SCALABLE )
473
#define FT_DRIVER_USES_OUTLINES( x ) !( FT_MODULE_CLASS( x )->module_flags & \
474
FT_MODULE_DRIVER_NO_OUTLINES )
476
#define FT_DRIVER_HAS_HINTER( x ) ( FT_MODULE_CLASS( x )->module_flags & \
477
FT_MODULE_DRIVER_HAS_HINTER )
480
/*************************************************************************/
483
/* FT_Get_Module_Interface */
486
/* Finds a module and returns its specific interface as a typeless */
490
/* library :: A handle to the library object. */
492
/* module_name :: The module's name (as an ASCII string). */
495
/* A module-specific interface if available, 0 otherwise. */
498
/* You should better be familiar with FreeType internals to know */
499
/* which module to look for, and what its interface is :-) */
501
FT_BASE( const void* )
502
FT_Get_Module_Interface( FT_Library library,
503
const char* mod_name );
505
FT_BASE( FT_Pointer )
506
ft_module_get_service( FT_Module module,
507
const char* service_id );
512
/*************************************************************************/
513
/*************************************************************************/
514
/*************************************************************************/
517
/**** FACE, SIZE & GLYPH SLOT OBJECTS ****/
520
/*************************************************************************/
521
/*************************************************************************/
522
/*************************************************************************/
524
/* a few macros used to perform easy typecasts with minimal brain damage */
526
#define FT_FACE( x ) ((FT_Face)(x))
527
#define FT_SIZE( x ) ((FT_Size)(x))
528
#define FT_SLOT( x ) ((FT_GlyphSlot)(x))
530
#define FT_FACE_DRIVER( x ) FT_FACE( x )->driver
531
#define FT_FACE_LIBRARY( x ) FT_FACE_DRIVER( x )->root.library
532
#define FT_FACE_MEMORY( x ) FT_FACE( x )->memory
533
#define FT_FACE_STREAM( x ) FT_FACE( x )->stream
535
#define FT_SIZE_FACE( x ) FT_SIZE( x )->face
536
#define FT_SLOT_FACE( x ) FT_SLOT( x )->face
538
#define FT_FACE_SLOT( x ) FT_FACE( x )->glyph
539
#define FT_FACE_SIZE( x ) FT_FACE( x )->size
542
/*************************************************************************/
545
/* FT_New_GlyphSlot */
548
/* It is sometimes useful to have more than one glyph slot for a */
549
/* given face object. This function is used to create additional */
550
/* slots. All of them are automatically discarded when the face is */
554
/* face :: A handle to a parent face object. */
557
/* aslot :: A handle to a new glyph slot object. */
560
/* FreeType error code. 0 means success. */
563
FT_New_GlyphSlot( FT_Face face,
564
FT_GlyphSlot *aslot );
567
/*************************************************************************/
570
/* FT_Done_GlyphSlot */
573
/* Destroys a given glyph slot. Remember however that all slots are */
574
/* automatically destroyed with its parent. Using this function is */
575
/* not always mandatory. */
578
/* slot :: A handle to a target glyph slot. */
581
FT_Done_GlyphSlot( FT_GlyphSlot slot );
585
#define FT_REQUEST_WIDTH( req ) \
586
( (req)->horiResolution \
587
? (FT_Pos)( (req)->width * (req)->horiResolution + 36 ) / 72 \
590
#define FT_REQUEST_HEIGHT( req ) \
591
( (req)->vertResolution \
592
? (FT_Pos)( (req)->height * (req)->vertResolution + 36 ) / 72 \
596
/* Set the metrics according to a bitmap strike. */
598
FT_Select_Metrics( FT_Face face,
599
FT_ULong strike_index );
602
/* Set the metrics according to a size request. */
604
FT_Request_Metrics( FT_Face face,
605
FT_Size_Request req );
608
/* Match a size request against `available_sizes'. */
610
FT_Match_Size( FT_Face face,
612
FT_Bool ignore_width,
613
FT_ULong* size_index );
616
/* Use the horizontal metrics to synthesize the vertical metrics. */
617
/* If `advance' is zero, it is also synthesized. */
619
ft_synthesize_vertical_metrics( FT_Glyph_Metrics* metrics,
623
/* Free the bitmap of a given glyphslot when needed (i.e., only when it */
624
/* was allocated with ft_glyphslot_alloc_bitmap). */
626
ft_glyphslot_free_bitmap( FT_GlyphSlot slot );
629
/* Allocate a new bitmap buffer in a glyph slot. */
631
ft_glyphslot_alloc_bitmap( FT_GlyphSlot slot,
635
/* Set the bitmap buffer in a glyph slot to a given pointer. The buffer */
636
/* will not be freed by a later call to ft_glyphslot_free_bitmap. */
638
ft_glyphslot_set_bitmap( FT_GlyphSlot slot,
642
/*************************************************************************/
643
/*************************************************************************/
644
/*************************************************************************/
647
/**** R E N D E R E R S ****/
650
/*************************************************************************/
651
/*************************************************************************/
652
/*************************************************************************/
655
#define FT_RENDERER( x ) ((FT_Renderer)( x ))
656
#define FT_GLYPH( x ) ((FT_Glyph)( x ))
657
#define FT_BITMAP_GLYPH( x ) ((FT_BitmapGlyph)( x ))
658
#define FT_OUTLINE_GLYPH( x ) ((FT_OutlineGlyph)( x ))
661
typedef struct FT_RendererRec_
664
FT_Renderer_Class* clazz;
665
FT_Glyph_Format glyph_format;
666
FT_Glyph_Class glyph_class;
669
FT_Raster_Render_Func raster_render;
670
FT_Renderer_RenderFunc render;
675
/*************************************************************************/
676
/*************************************************************************/
677
/*************************************************************************/
680
/**** F O N T D R I V E R S ****/
683
/*************************************************************************/
684
/*************************************************************************/
685
/*************************************************************************/
688
/* typecast a module into a driver easily */
689
#define FT_DRIVER( x ) ((FT_Driver)(x))
691
/* typecast a module as a driver, and get its driver class */
692
#define FT_DRIVER_CLASS( x ) FT_DRIVER( x )->clazz
695
/*************************************************************************/
701
/* The root font driver class. A font driver is responsible for */
702
/* managing and loading font files of a given format. */
705
/* root :: Contains the fields of the root module class. */
707
/* clazz :: A pointer to the font driver's class. Note that */
708
/* this is NOT root.clazz. `class' wasn't used */
709
/* as it is a reserved word in C++. */
711
/* faces_list :: The list of faces currently opened by this */
714
/* extensions :: A typeless pointer to the driver's extensions */
715
/* registry, if they are supported through the */
716
/* configuration macro FT_CONFIG_OPTION_EXTENSIONS. */
718
/* glyph_loader :: The glyph loader for all faces managed by this */
719
/* driver. This object isn't defined for unscalable */
722
typedef struct FT_DriverRec_
725
FT_Driver_Class clazz;
727
FT_ListRec faces_list;
730
FT_GlyphLoader glyph_loader;
735
/*************************************************************************/
736
/*************************************************************************/
737
/*************************************************************************/
740
/**** L I B R A R I E S ****/
743
/*************************************************************************/
744
/*************************************************************************/
745
/*************************************************************************/
748
/* This hook is used by the TrueType debugger. It must be set to an */
749
/* alternate truetype bytecode interpreter function. */
750
#define FT_DEBUG_HOOK_TRUETYPE 0
753
/* Set this debug hook to a non-null pointer to force unpatented hinting */
754
/* for all faces when both TT_USE_BYTECODE_INTERPRETER and */
755
/* TT_CONFIG_OPTION_UNPATENTED_HINTING are defined. This is only used */
756
/* during debugging. */
757
#define FT_DEBUG_HOOK_UNPATENTED_HINTING 1
760
typedef void (*FT_Bitmap_LcdFilterFunc)( FT_Bitmap* bitmap,
761
FT_Render_Mode render_mode,
762
FT_Library library );
765
/*************************************************************************/
771
/* The FreeType library class. This is the root of all FreeType */
772
/* data. Use FT_New_Library() to create a library object, and */
773
/* FT_Done_Library() to discard it and all child objects. */
776
/* memory :: The library's memory object. Manages memory */
779
/* generic :: Client data variable. Used to extend the */
780
/* Library class by higher levels and clients. */
782
/* version_major :: The major version number of the library. */
784
/* version_minor :: The minor version number of the library. */
786
/* version_patch :: The current patch level of the library. */
788
/* num_modules :: The number of modules currently registered */
789
/* within this library. This is set to 0 for new */
790
/* libraries. New modules are added through the */
791
/* FT_Add_Module() API function. */
793
/* modules :: A table used to store handles to the currently */
794
/* registered modules. Note that each font driver */
795
/* contains a list of its opened faces. */
797
/* renderers :: The list of renderers currently registered */
798
/* within the library. */
800
/* cur_renderer :: The current outline renderer. This is a */
801
/* shortcut used to avoid parsing the list on */
802
/* each call to FT_Outline_Render(). It is a */
803
/* handle to the current renderer for the */
804
/* FT_GLYPH_FORMAT_OUTLINE format. */
806
/* auto_hinter :: XXX */
808
/* raster_pool :: The raster object's render pool. This can */
809
/* ideally be changed dynamically at run-time. */
811
/* raster_pool_size :: The size of the render pool in bytes. */
813
/* debug_hooks :: XXX */
815
/* lcd_filter :: If subpixel rendering is activated, the */
816
/* selected LCD filter mode. */
818
/* lcd_extra :: If subpixel rendering is activated, the number */
819
/* of extra pixels needed for the LCD filter. */
821
/* lcd_weights :: If subpixel rendering is activated, the LCD */
822
/* filter weights, if any. */
824
/* lcd_filter_func :: If subpixel rendering is activated, the LCD */
825
/* filtering callback function. */
827
/* pic_container :: Contains global structs and tables, instead */
828
/* of defining them globallly. */
830
/* refcount :: A counter initialized to~1 at the time an */
831
/* @FT_Library structure is created. */
832
/* @FT_Reference_Library increments this counter, */
833
/* and @FT_Done_Library only destroys a library */
834
/* if the counter is~1, otherwise it simply */
837
typedef struct FT_LibraryRec_
839
FT_Memory memory; /* library's memory manager */
843
FT_Int version_major;
844
FT_Int version_minor;
845
FT_Int version_patch;
848
FT_Module modules[FT_MAX_MODULES]; /* module objects */
850
FT_ListRec renderers; /* list of renderers */
851
FT_Renderer cur_renderer; /* current outline renderer */
852
FT_Module auto_hinter;
854
FT_Byte* raster_pool; /* scan-line conversion */
856
FT_ULong raster_pool_size; /* size of render pool in bytes */
858
FT_DebugHook_Func debug_hooks[4];
860
#ifdef FT_CONFIG_OPTION_SUBPIXEL_RENDERING
861
FT_LcdFilter lcd_filter;
862
FT_Int lcd_extra; /* number of extra pixels */
863
FT_Byte lcd_weights[7]; /* filter weights, if any */
864
FT_Bitmap_LcdFilterFunc lcd_filter_func; /* filtering callback */
867
#ifdef FT_CONFIG_OPTION_PIC
868
FT_PIC_Container pic_container;
876
FT_BASE( FT_Renderer )
877
FT_Lookup_Renderer( FT_Library library,
878
FT_Glyph_Format format,
882
FT_Render_Glyph_Internal( FT_Library library,
884
FT_Render_Mode render_mode );
887
(*FT_Face_GetPostscriptNameFunc)( FT_Face face );
890
(*FT_Face_GetGlyphNameFunc)( FT_Face face,
893
FT_UInt buffer_max );
896
(*FT_Face_GetGlyphNameIndexFunc)( FT_Face face,
897
FT_String* glyph_name );
900
#ifndef FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM
902
/*************************************************************************/
908
/* Creates a new memory object. */
911
/* A pointer to the new memory object. 0 in case of error. */
914
FT_New_Memory( void );
917
/*************************************************************************/
923
/* Discards memory manager. */
926
/* memory :: A handle to the memory manager. */
929
FT_Done_Memory( FT_Memory memory );
931
#endif /* !FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM */
934
/* Define default raster's interface. The default raster is located in */
935
/* `src/base/ftraster.c'. */
937
/* Client applications can register new rasters through the */
938
/* FT_Set_Raster() API. */
940
#ifndef FT_NO_DEFAULT_RASTER
941
FT_EXPORT_VAR( FT_Raster_Funcs ) ft_default_raster;
944
/*************************************************************************/
945
/*************************************************************************/
946
/*************************************************************************/
949
/**** PIC-Support Macros for ftimage.h ****/
952
/*************************************************************************/
953
/*************************************************************************/
954
/*************************************************************************/
957
/*************************************************************************/
960
/* FT_DEFINE_OUTLINE_FUNCS */
963
/* Used to initialize an instance of FT_Outline_Funcs struct. */
964
/* When FT_CONFIG_OPTION_PIC is defined an init funtion will need to */
965
/* called with a pre-allocated stracture to be filled. */
966
/* When FT_CONFIG_OPTION_PIC is not defined the struct will be */
967
/* allocated in the global scope (or the scope where the macro */
970
#ifndef FT_CONFIG_OPTION_PIC
972
#define FT_DEFINE_OUTLINE_FUNCS(class_, move_to_, line_to_, conic_to_, \
973
cubic_to_, shift_, delta_) \
974
static const FT_Outline_Funcs class_ = \
976
move_to_, line_to_, conic_to_, cubic_to_, shift_, delta_ \
979
#else /* FT_CONFIG_OPTION_PIC */
981
#define FT_DEFINE_OUTLINE_FUNCS(class_, move_to_, line_to_, conic_to_, \
982
cubic_to_, shift_, delta_) \
984
Init_Class_##class_( FT_Outline_Funcs* clazz ) \
986
clazz->move_to = move_to_; \
987
clazz->line_to = line_to_; \
988
clazz->conic_to = conic_to_; \
989
clazz->cubic_to = cubic_to_; \
990
clazz->shift = shift_; \
991
clazz->delta = delta_; \
995
#endif /* FT_CONFIG_OPTION_PIC */
997
/*************************************************************************/
1000
/* FT_DEFINE_RASTER_FUNCS */
1003
/* Used to initialize an instance of FT_Raster_Funcs struct. */
1004
/* When FT_CONFIG_OPTION_PIC is defined an init funtion will need to */
1005
/* called with a pre-allocated stracture to be filled. */
1006
/* When FT_CONFIG_OPTION_PIC is not defined the struct will be */
1007
/* allocated in the global scope (or the scope where the macro */
1010
#ifndef FT_CONFIG_OPTION_PIC
1012
#define FT_DEFINE_RASTER_FUNCS(class_, glyph_format_, raster_new_, \
1013
raster_reset_, raster_set_mode_, \
1014
raster_render_, raster_done_) \
1015
const FT_Raster_Funcs class_ = \
1017
glyph_format_, raster_new_, raster_reset_, \
1018
raster_set_mode_, raster_render_, raster_done_ \
1021
#else /* FT_CONFIG_OPTION_PIC */
1023
#define FT_DEFINE_RASTER_FUNCS(class_, glyph_format_, raster_new_, \
1024
raster_reset_, raster_set_mode_, raster_render_, raster_done_) \
1026
FT_Init_Class_##class_( FT_Raster_Funcs* clazz ) \
1028
clazz->glyph_format = glyph_format_; \
1029
clazz->raster_new = raster_new_; \
1030
clazz->raster_reset = raster_reset_; \
1031
clazz->raster_set_mode = raster_set_mode_; \
1032
clazz->raster_render = raster_render_; \
1033
clazz->raster_done = raster_done_; \
1036
#endif /* FT_CONFIG_OPTION_PIC */
1038
/*************************************************************************/
1039
/*************************************************************************/
1040
/*************************************************************************/
1043
/**** PIC-Support Macros for ftrender.h ****/
1046
/*************************************************************************/
1047
/*************************************************************************/
1048
/*************************************************************************/
1052
/*************************************************************************/
1055
/* FT_DEFINE_GLYPH */
1058
/* Used to initialize an instance of FT_Glyph_Class struct. */
1059
/* When FT_CONFIG_OPTION_PIC is defined an init funtion will need to */
1060
/* called with a pre-allocated stracture to be filled. */
1061
/* When FT_CONFIG_OPTION_PIC is not defined the struct will be */
1062
/* allocated in the global scope (or the scope where the macro */
1065
#ifndef FT_CONFIG_OPTION_PIC
1067
#define FT_DEFINE_GLYPH(class_, size_, format_, init_, done_, copy_, \
1068
transform_, bbox_, prepare_) \
1069
FT_CALLBACK_TABLE_DEF \
1070
const FT_Glyph_Class class_ = \
1072
size_, format_, init_, done_, copy_, transform_, bbox_, prepare_ \
1075
#else /* FT_CONFIG_OPTION_PIC */
1077
#define FT_DEFINE_GLYPH(class_, size_, format_, init_, done_, copy_, \
1078
transform_, bbox_, prepare_) \
1080
FT_Init_Class_##class_( FT_Glyph_Class* clazz ) \
1082
clazz->glyph_size = size_; \
1083
clazz->glyph_format = format_; \
1084
clazz->glyph_init = init_; \
1085
clazz->glyph_done = done_; \
1086
clazz->glyph_copy = copy_; \
1087
clazz->glyph_transform = transform_; \
1088
clazz->glyph_bbox = bbox_; \
1089
clazz->glyph_prepare = prepare_; \
1092
#endif /* FT_CONFIG_OPTION_PIC */
1094
/*************************************************************************/
1097
/* FT_DECLARE_RENDERER */
1100
/* Used to create a forward declaration of a */
1101
/* FT_Renderer_Class stract instance. */
1104
/* FT_DEFINE_RENDERER */
1107
/* Used to initialize an instance of FT_Renderer_Class struct. */
1109
/* When FT_CONFIG_OPTION_PIC is defined a Create funtion will need */
1110
/* to called with a pointer where the allocated stracture is returned.*/
1111
/* And when it is no longer needed a Destroy function needs */
1112
/* to be called to release that allocation. */
1113
/* fcinit.c (ft_create_default_module_classes) already contains */
1114
/* a mechanism to call these functions for the default modules */
1115
/* described in ftmodule.h */
1117
/* Notice that the created Create and Destroy functions call */
1118
/* pic_init and pic_free function to allow you to manually allocate */
1119
/* and initialize any additional global data, like module specific */
1120
/* interface, and put them in the global pic container defined in */
1121
/* ftpic.h. if you don't need them just implement the functions as */
1122
/* empty to resolve the link error. */
1124
/* When FT_CONFIG_OPTION_PIC is not defined the struct will be */
1125
/* allocated in the global scope (or the scope where the macro */
1128
#ifndef FT_CONFIG_OPTION_PIC
1130
#define FT_DECLARE_RENDERER(class_) \
1131
FT_EXPORT_VAR( const FT_Renderer_Class ) class_;
1133
#define FT_DEFINE_RENDERER(class_, \
1134
flags_, size_, name_, version_, requires_, \
1135
interface_, init_, done_, get_interface_, \
1136
glyph_format_, render_glyph_, transform_glyph_, \
1137
get_glyph_cbox_, set_mode_, raster_class_ ) \
1138
FT_CALLBACK_TABLE_DEF \
1139
const FT_Renderer_Class class_ = \
1141
FT_DEFINE_ROOT_MODULE(flags_,size_,name_,version_,requires_, \
1142
interface_,init_,done_,get_interface_) \
1153
#else /* FT_CONFIG_OPTION_PIC */
1155
#define FT_DECLARE_RENDERER(class_) FT_DECLARE_MODULE(class_)
1157
#define FT_DEFINE_RENDERER(class_, \
1158
flags_, size_, name_, version_, requires_, \
1159
interface_, init_, done_, get_interface_, \
1160
glyph_format_, render_glyph_, transform_glyph_, \
1161
get_glyph_cbox_, set_mode_, raster_class_ ) \
1162
void class_##_pic_free( FT_Library library ); \
1163
FT_Error class_##_pic_init( FT_Library library ); \
1166
FT_Destroy_Class_##class_( FT_Library library, \
1167
FT_Module_Class* clazz ) \
1169
FT_Renderer_Class* rclazz = (FT_Renderer_Class*)clazz; \
1170
FT_Memory memory = library->memory; \
1171
class_##_pic_free( library ); \
1173
FT_FREE( rclazz ); \
1177
FT_Create_Class_##class_( FT_Library library, \
1178
FT_Module_Class** output_class ) \
1180
FT_Renderer_Class* clazz; \
1182
FT_Memory memory = library->memory; \
1184
if ( FT_ALLOC( clazz, sizeof(*clazz) ) ) \
1187
error = class_##_pic_init( library ); \
1194
FT_DEFINE_ROOT_MODULE(flags_,size_,name_,version_,requires_, \
1195
interface_,init_,done_,get_interface_) \
1197
clazz->glyph_format = glyph_format_; \
1199
clazz->render_glyph = render_glyph_; \
1200
clazz->transform_glyph = transform_glyph_; \
1201
clazz->get_glyph_cbox = get_glyph_cbox_; \
1202
clazz->set_mode = set_mode_; \
1204
clazz->raster_class = raster_class_; \
1206
*output_class = (FT_Module_Class*)clazz; \
1212
#endif /* FT_CONFIG_OPTION_PIC */
1214
/*************************************************************************/
1215
/*************************************************************************/
1216
/*************************************************************************/
1219
/**** PIC-Support Macros for ftmodapi.h ****/
1222
/*************************************************************************/
1223
/*************************************************************************/
1224
/*************************************************************************/
1227
#ifdef FT_CONFIG_OPTION_PIC
1229
/*************************************************************************/
1232
/* FT_Module_Creator */
1235
/* A function used to create (allocate) a new module class object. */
1236
/* The object's members are initialized, but the module itself is */
1240
/* memory :: A handle to the memory manager. */
1241
/* output_class :: Initialized with the newly allocated class. */
1244
(*FT_Module_Creator)( FT_Memory memory,
1245
FT_Module_Class** output_class );
1247
/*************************************************************************/
1250
/* FT_Module_Destroyer */
1253
/* A function used to destroy (deallocate) a module class object. */
1256
/* memory :: A handle to the memory manager. */
1257
/* clazz :: Module class to destroy. */
1260
(*FT_Module_Destroyer)( FT_Memory memory,
1261
FT_Module_Class* clazz );
1265
/*************************************************************************/
1268
/* FT_DECLARE_MODULE */
1271
/* Used to create a forward declaration of a */
1272
/* FT_Module_Class stract instance. */
1275
/* FT_DEFINE_MODULE */
1278
/* Used to initialize an instance of FT_Module_Class struct. */
1280
/* When FT_CONFIG_OPTION_PIC is defined a Create funtion will need */
1281
/* to called with a pointer where the allocated stracture is returned.*/
1282
/* And when it is no longer needed a Destroy function needs */
1283
/* to be called to release that allocation. */
1284
/* fcinit.c (ft_create_default_module_classes) already contains */
1285
/* a mechanism to call these functions for the default modules */
1286
/* described in ftmodule.h */
1288
/* Notice that the created Create and Destroy functions call */
1289
/* pic_init and pic_free function to allow you to manually allocate */
1290
/* and initialize any additional global data, like module specific */
1291
/* interface, and put them in the global pic container defined in */
1292
/* ftpic.h. if you don't need them just implement the functions as */
1293
/* empty to resolve the link error. */
1295
/* When FT_CONFIG_OPTION_PIC is not defined the struct will be */
1296
/* allocated in the global scope (or the scope where the macro */
1300
/* FT_DEFINE_ROOT_MODULE */
1303
/* Used to initialize an instance of FT_Module_Class struct inside */
1304
/* another stract that contains it or in a function that initializes */
1305
/* that containing stract */
1307
#ifndef FT_CONFIG_OPTION_PIC
1309
#define FT_DECLARE_MODULE(class_) \
1311
const FT_Module_Class class_; \
1313
#define FT_DEFINE_ROOT_MODULE(flags_, size_, name_, version_, requires_, \
1314
interface_, init_, done_, get_interface_) \
1330
#define FT_DEFINE_MODULE(class_, flags_, size_, name_, version_, requires_, \
1331
interface_, init_, done_, get_interface_) \
1332
FT_CALLBACK_TABLE_DEF \
1333
const FT_Module_Class class_ = \
1350
#else /* FT_CONFIG_OPTION_PIC */
1352
#define FT_DECLARE_MODULE(class_) \
1353
FT_Error FT_Create_Class_##class_( FT_Library library, \
1354
FT_Module_Class** output_class ); \
1355
void FT_Destroy_Class_##class_( FT_Library library, \
1356
FT_Module_Class* clazz );
1358
#define FT_DEFINE_ROOT_MODULE(flags_, size_, name_, version_, requires_, \
1359
interface_, init_, done_, get_interface_) \
1360
clazz->root.module_flags = flags_; \
1361
clazz->root.module_size = size_; \
1362
clazz->root.module_name = name_; \
1363
clazz->root.module_version = version_; \
1364
clazz->root.module_requires = requires_; \
1366
clazz->root.module_interface = interface_; \
1368
clazz->root.module_init = init_; \
1369
clazz->root.module_done = done_; \
1370
clazz->root.get_interface = get_interface_;
1372
#define FT_DEFINE_MODULE(class_, flags_, size_, name_, version_, requires_, \
1373
interface_, init_, done_, get_interface_) \
1374
void class_##_pic_free( FT_Library library ); \
1375
FT_Error class_##_pic_init( FT_Library library ); \
1378
FT_Destroy_Class_##class_( FT_Library library, \
1379
FT_Module_Class* clazz ) \
1381
FT_Memory memory = library->memory; \
1382
class_##_pic_free( library ); \
1388
FT_Create_Class_##class_( FT_Library library, \
1389
FT_Module_Class** output_class ) \
1391
FT_Memory memory = library->memory; \
1392
FT_Module_Class* clazz; \
1395
if ( FT_ALLOC( clazz, sizeof(*clazz) ) ) \
1397
error = class_##_pic_init( library ); \
1404
clazz->module_flags = flags_; \
1405
clazz->module_size = size_; \
1406
clazz->module_name = name_; \
1407
clazz->module_version = version_; \
1408
clazz->module_requires = requires_; \
1410
clazz->module_interface = interface_; \
1412
clazz->module_init = init_; \
1413
clazz->module_done = done_; \
1414
clazz->get_interface = get_interface_; \
1416
*output_class = clazz; \
1420
#endif /* FT_CONFIG_OPTION_PIC */
1425
#endif /* __FTOBJS_H__ */
added
removed
tests/freetype/include/freetype/internal/ftobjs.h
