nuclear@0: /***************************************************************************/ nuclear@0: /* */ nuclear@0: /* ftobjs.h */ nuclear@0: /* */ nuclear@0: /* The FreeType private base classes (specification). */ nuclear@0: /* */ nuclear@0: /* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2008, 2010 by */ nuclear@0: /* David Turner, Robert Wilhelm, and Werner Lemberg. */ nuclear@0: /* */ nuclear@0: /* This file is part of the FreeType project, and may only be used, */ nuclear@0: /* modified, and distributed under the terms of the FreeType project */ nuclear@0: /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ nuclear@0: /* this file you indicate that you have read the license and */ nuclear@0: /* understand and accept it fully. */ nuclear@0: /* */ nuclear@0: /***************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* This file contains the definition of all internal FreeType classes. */ nuclear@0: /* */ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #ifndef __FTOBJS_H__ nuclear@0: #define __FTOBJS_H__ nuclear@0: nuclear@0: #include nuclear@0: #include FT_RENDER_H nuclear@0: #include FT_SIZES_H nuclear@0: #include FT_LCD_FILTER_H nuclear@0: #include FT_INTERNAL_MEMORY_H nuclear@0: #include FT_INTERNAL_GLYPH_LOADER_H nuclear@0: #include FT_INTERNAL_DRIVER_H nuclear@0: #include FT_INTERNAL_AUTOHINT_H nuclear@0: #include FT_INTERNAL_SERVICE_H nuclear@0: #include FT_INTERNAL_PIC_H nuclear@0: nuclear@0: #ifdef FT_CONFIG_OPTION_INCREMENTAL nuclear@0: #include FT_INCREMENTAL_H nuclear@0: #endif nuclear@0: nuclear@0: nuclear@0: FT_BEGIN_HEADER nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* Some generic definitions. */ nuclear@0: /* */ nuclear@0: #ifndef TRUE nuclear@0: #define TRUE 1 nuclear@0: #endif nuclear@0: nuclear@0: #ifndef FALSE nuclear@0: #define FALSE 0 nuclear@0: #endif nuclear@0: nuclear@0: #ifndef NULL nuclear@0: #define NULL (void*)0 nuclear@0: #endif nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* The min and max functions missing in C. As usual, be careful not to */ nuclear@0: /* write things like FT_MIN( a++, b++ ) to avoid side effects. */ nuclear@0: /* */ nuclear@0: #define FT_MIN( a, b ) ( (a) < (b) ? (a) : (b) ) nuclear@0: #define FT_MAX( a, b ) ( (a) > (b) ? (a) : (b) ) nuclear@0: nuclear@0: #define FT_ABS( a ) ( (a) < 0 ? -(a) : (a) ) nuclear@0: nuclear@0: nuclear@0: #define FT_PAD_FLOOR( x, n ) ( (x) & ~((n)-1) ) nuclear@0: #define FT_PAD_ROUND( x, n ) FT_PAD_FLOOR( (x) + ((n)/2), n ) nuclear@0: #define FT_PAD_CEIL( x, n ) FT_PAD_FLOOR( (x) + ((n)-1), n ) nuclear@0: nuclear@0: #define FT_PIX_FLOOR( x ) ( (x) & ~63 ) nuclear@0: #define FT_PIX_ROUND( x ) FT_PIX_FLOOR( (x) + 32 ) nuclear@0: #define FT_PIX_CEIL( x ) FT_PIX_FLOOR( (x) + 63 ) nuclear@0: nuclear@0: nuclear@0: /* nuclear@0: * Return the highest power of 2 that is <= value; this correspond to nuclear@0: * the highest bit in a given 32-bit value. nuclear@0: */ nuclear@0: FT_BASE( FT_UInt32 ) nuclear@0: ft_highpow2( FT_UInt32 value ); nuclear@0: nuclear@0: nuclear@0: /* nuclear@0: * character classification functions -- since these are used to parse nuclear@0: * font files, we must not use those in which are nuclear@0: * locale-dependent nuclear@0: */ nuclear@0: #define ft_isdigit( x ) ( ( (unsigned)(x) - '0' ) < 10U ) nuclear@0: nuclear@0: #define ft_isxdigit( x ) ( ( (unsigned)(x) - '0' ) < 10U || \ nuclear@0: ( (unsigned)(x) - 'a' ) < 6U || \ nuclear@0: ( (unsigned)(x) - 'A' ) < 6U ) nuclear@0: nuclear@0: /* the next two macros assume ASCII representation */ nuclear@0: #define ft_isupper( x ) ( ( (unsigned)(x) - 'A' ) < 26U ) nuclear@0: #define ft_islower( x ) ( ( (unsigned)(x) - 'a' ) < 26U ) nuclear@0: nuclear@0: #define ft_isalpha( x ) ( ft_isupper( x ) || ft_islower( x ) ) nuclear@0: #define ft_isalnum( x ) ( ft_isdigit( x ) || ft_isalpha( x ) ) nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** C H A R M A P S ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: /* handle to internal charmap object */ nuclear@0: typedef struct FT_CMapRec_* FT_CMap; nuclear@0: nuclear@0: /* handle to charmap class structure */ nuclear@0: typedef const struct FT_CMap_ClassRec_* FT_CMap_Class; nuclear@0: nuclear@0: /* internal charmap object structure */ nuclear@0: typedef struct FT_CMapRec_ nuclear@0: { nuclear@0: FT_CharMapRec charmap; nuclear@0: FT_CMap_Class clazz; nuclear@0: nuclear@0: } FT_CMapRec; nuclear@0: nuclear@0: /* typecase any pointer to a charmap handle */ nuclear@0: #define FT_CMAP( x ) ((FT_CMap)( x )) nuclear@0: nuclear@0: /* obvious macros */ nuclear@0: #define FT_CMAP_PLATFORM_ID( x ) FT_CMAP( x )->charmap.platform_id nuclear@0: #define FT_CMAP_ENCODING_ID( x ) FT_CMAP( x )->charmap.encoding_id nuclear@0: #define FT_CMAP_ENCODING( x ) FT_CMAP( x )->charmap.encoding nuclear@0: #define FT_CMAP_FACE( x ) FT_CMAP( x )->charmap.face nuclear@0: nuclear@0: nuclear@0: /* class method definitions */ nuclear@0: typedef FT_Error nuclear@0: (*FT_CMap_InitFunc)( FT_CMap cmap, nuclear@0: FT_Pointer init_data ); nuclear@0: nuclear@0: typedef void nuclear@0: (*FT_CMap_DoneFunc)( FT_CMap cmap ); nuclear@0: nuclear@0: typedef FT_UInt nuclear@0: (*FT_CMap_CharIndexFunc)( FT_CMap cmap, nuclear@0: FT_UInt32 char_code ); nuclear@0: nuclear@0: typedef FT_UInt nuclear@0: (*FT_CMap_CharNextFunc)( FT_CMap cmap, nuclear@0: FT_UInt32 *achar_code ); nuclear@0: nuclear@0: typedef FT_UInt nuclear@0: (*FT_CMap_CharVarIndexFunc)( FT_CMap cmap, nuclear@0: FT_CMap unicode_cmap, nuclear@0: FT_UInt32 char_code, nuclear@0: FT_UInt32 variant_selector ); nuclear@0: nuclear@0: typedef FT_Bool nuclear@0: (*FT_CMap_CharVarIsDefaultFunc)( FT_CMap cmap, nuclear@0: FT_UInt32 char_code, nuclear@0: FT_UInt32 variant_selector ); nuclear@0: nuclear@0: typedef FT_UInt32 * nuclear@0: (*FT_CMap_VariantListFunc)( FT_CMap cmap, nuclear@0: FT_Memory mem ); nuclear@0: nuclear@0: typedef FT_UInt32 * nuclear@0: (*FT_CMap_CharVariantListFunc)( FT_CMap cmap, nuclear@0: FT_Memory mem, nuclear@0: FT_UInt32 char_code ); nuclear@0: nuclear@0: typedef FT_UInt32 * nuclear@0: (*FT_CMap_VariantCharListFunc)( FT_CMap cmap, nuclear@0: FT_Memory mem, nuclear@0: FT_UInt32 variant_selector ); nuclear@0: nuclear@0: nuclear@0: typedef struct FT_CMap_ClassRec_ nuclear@0: { nuclear@0: FT_ULong size; nuclear@0: FT_CMap_InitFunc init; nuclear@0: FT_CMap_DoneFunc done; nuclear@0: FT_CMap_CharIndexFunc char_index; nuclear@0: FT_CMap_CharNextFunc char_next; nuclear@0: nuclear@0: /* Subsequent entries are special ones for format 14 -- the variant */ nuclear@0: /* selector subtable which behaves like no other */ nuclear@0: nuclear@0: FT_CMap_CharVarIndexFunc char_var_index; nuclear@0: FT_CMap_CharVarIsDefaultFunc char_var_default; nuclear@0: FT_CMap_VariantListFunc variant_list; nuclear@0: FT_CMap_CharVariantListFunc charvariant_list; nuclear@0: FT_CMap_VariantCharListFunc variantchar_list; nuclear@0: nuclear@0: } FT_CMap_ClassRec; nuclear@0: nuclear@0: #ifndef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: #define FT_DECLARE_CMAP_CLASS(class_) \ nuclear@0: FT_CALLBACK_TABLE const FT_CMap_ClassRec class_; nuclear@0: nuclear@0: #define FT_DEFINE_CMAP_CLASS(class_, size_, init_, done_, char_index_, \ nuclear@0: char_next_, char_var_index_, char_var_default_, variant_list_, \ nuclear@0: charvariant_list_, variantchar_list_) \ nuclear@0: FT_CALLBACK_TABLE_DEF \ nuclear@0: const FT_CMap_ClassRec class_ = \ nuclear@0: { \ nuclear@0: size_, init_, done_, char_index_, char_next_, char_var_index_, \ nuclear@0: char_var_default_, variant_list_, charvariant_list_, variantchar_list_ \ nuclear@0: }; nuclear@0: #else /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: #define FT_DECLARE_CMAP_CLASS(class_) \ nuclear@0: void FT_Init_Class_##class_( FT_Library library, FT_CMap_ClassRec* clazz); nuclear@0: nuclear@0: #define FT_DEFINE_CMAP_CLASS(class_, size_, init_, done_, char_index_, \ nuclear@0: char_next_, char_var_index_, char_var_default_, variant_list_, \ nuclear@0: charvariant_list_, variantchar_list_) \ nuclear@0: void \ nuclear@0: FT_Init_Class_##class_( FT_Library library, \ nuclear@0: FT_CMap_ClassRec* clazz) \ nuclear@0: { \ nuclear@0: FT_UNUSED(library); \ nuclear@0: clazz->size = size_; \ nuclear@0: clazz->init = init_; \ nuclear@0: clazz->done = done_; \ nuclear@0: clazz->char_index = char_index_; \ nuclear@0: clazz->char_next = char_next_; \ nuclear@0: clazz->char_var_index = char_var_index_; \ nuclear@0: clazz->char_var_default = char_var_default_; \ nuclear@0: clazz->variant_list = variant_list_; \ nuclear@0: clazz->charvariant_list = charvariant_list_; \ nuclear@0: clazz->variantchar_list = variantchar_list_; \ nuclear@0: } nuclear@0: #endif /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: /* create a new charmap and add it to charmap->face */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_CMap_New( FT_CMap_Class clazz, nuclear@0: FT_Pointer init_data, nuclear@0: FT_CharMap charmap, nuclear@0: FT_CMap *acmap ); nuclear@0: nuclear@0: /* destroy a charmap and remove it from face's list */ nuclear@0: FT_BASE( void ) nuclear@0: FT_CMap_Done( FT_CMap cmap ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Face_InternalRec */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* This structure contains the internal fields of each FT_Face */ nuclear@0: /* object. These fields may change between different releases of */ nuclear@0: /* FreeType. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* max_points :: */ nuclear@0: /* The maximal number of points used to store the vectorial outline */ nuclear@0: /* of any glyph in this face. If this value cannot be known in */ nuclear@0: /* advance, or if the face isn't scalable, this should be set to 0. */ nuclear@0: /* Only relevant for scalable formats. */ nuclear@0: /* */ nuclear@0: /* max_contours :: */ nuclear@0: /* The maximal number of contours used to store the vectorial */ nuclear@0: /* outline of any glyph in this face. If this value cannot be */ nuclear@0: /* known in advance, or if the face isn't scalable, this should be */ nuclear@0: /* set to 0. Only relevant for scalable formats. */ nuclear@0: /* */ nuclear@0: /* transform_matrix :: */ nuclear@0: /* A 2x2 matrix of 16.16 coefficients used to transform glyph */ nuclear@0: /* outlines after they are loaded from the font. Only used by the */ nuclear@0: /* convenience functions. */ nuclear@0: /* */ nuclear@0: /* transform_delta :: */ nuclear@0: /* A translation vector used to transform glyph outlines after they */ nuclear@0: /* are loaded from the font. Only used by the convenience */ nuclear@0: /* functions. */ nuclear@0: /* */ nuclear@0: /* transform_flags :: */ nuclear@0: /* Some flags used to classify the transform. Only used by the */ nuclear@0: /* convenience functions. */ nuclear@0: /* */ nuclear@0: /* services :: */ nuclear@0: /* A cache for frequently used services. It should be only */ nuclear@0: /* accessed with the macro `FT_FACE_LOOKUP_SERVICE'. */ nuclear@0: /* */ nuclear@0: /* incremental_interface :: */ nuclear@0: /* If non-null, the interface through which glyph data and metrics */ nuclear@0: /* are loaded incrementally for faces that do not provide all of */ nuclear@0: /* this data when first opened. This field exists only if */ nuclear@0: /* @FT_CONFIG_OPTION_INCREMENTAL is defined. */ nuclear@0: /* */ nuclear@0: /* ignore_unpatented_hinter :: */ nuclear@0: /* This boolean flag instructs the glyph loader to ignore the */ nuclear@0: /* native font hinter, if one is found. This is exclusively used */ nuclear@0: /* in the case when the unpatented hinter is compiled within the */ nuclear@0: /* library. */ nuclear@0: /* */ nuclear@0: /* refcount :: */ nuclear@0: /* A counter initialized to~1 at the time an @FT_Face structure is */ nuclear@0: /* created. @FT_Reference_Face increments this counter, and */ nuclear@0: /* @FT_Done_Face only destroys a face if the counter is~1, */ nuclear@0: /* otherwise it simply decrements it. */ nuclear@0: /* */ nuclear@0: typedef struct FT_Face_InternalRec_ nuclear@0: { nuclear@0: #ifdef FT_CONFIG_OPTION_OLD_INTERNALS nuclear@0: FT_UShort reserved1; nuclear@0: FT_Short reserved2; nuclear@0: #endif nuclear@0: FT_Matrix transform_matrix; nuclear@0: FT_Vector transform_delta; nuclear@0: FT_Int transform_flags; nuclear@0: nuclear@0: FT_ServiceCacheRec services; nuclear@0: nuclear@0: #ifdef FT_CONFIG_OPTION_INCREMENTAL nuclear@0: FT_Incremental_InterfaceRec* incremental_interface; nuclear@0: #endif nuclear@0: nuclear@0: FT_Bool ignore_unpatented_hinter; nuclear@0: FT_UInt refcount; nuclear@0: nuclear@0: } FT_Face_InternalRec; nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Slot_InternalRec */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* This structure contains the internal fields of each FT_GlyphSlot */ nuclear@0: /* object. These fields may change between different releases of */ nuclear@0: /* FreeType. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* loader :: The glyph loader object used to load outlines */ nuclear@0: /* into the glyph slot. */ nuclear@0: /* */ nuclear@0: /* flags :: Possible values are zero or */ nuclear@0: /* FT_GLYPH_OWN_BITMAP. The latter indicates */ nuclear@0: /* that the FT_GlyphSlot structure owns the */ nuclear@0: /* bitmap buffer. */ nuclear@0: /* */ nuclear@0: /* glyph_transformed :: Boolean. Set to TRUE when the loaded glyph */ nuclear@0: /* must be transformed through a specific */ nuclear@0: /* font transformation. This is _not_ the same */ nuclear@0: /* as the face transform set through */ nuclear@0: /* FT_Set_Transform(). */ nuclear@0: /* */ nuclear@0: /* glyph_matrix :: The 2x2 matrix corresponding to the glyph */ nuclear@0: /* transformation, if necessary. */ nuclear@0: /* */ nuclear@0: /* glyph_delta :: The 2d translation vector corresponding to */ nuclear@0: /* the glyph transformation, if necessary. */ nuclear@0: /* */ nuclear@0: /* glyph_hints :: Format-specific glyph hints management. */ nuclear@0: /* */ nuclear@0: nuclear@0: #define FT_GLYPH_OWN_BITMAP 0x1 nuclear@0: nuclear@0: typedef struct FT_Slot_InternalRec_ nuclear@0: { nuclear@0: FT_GlyphLoader loader; nuclear@0: FT_UInt flags; nuclear@0: FT_Bool glyph_transformed; nuclear@0: FT_Matrix glyph_matrix; nuclear@0: FT_Vector glyph_delta; nuclear@0: void* glyph_hints; nuclear@0: nuclear@0: } FT_GlyphSlot_InternalRec; nuclear@0: nuclear@0: nuclear@0: #if 0 nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Size_InternalRec */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* This structure contains the internal fields of each FT_Size */ nuclear@0: /* object. Currently, it's empty. */ nuclear@0: /* */ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: typedef struct FT_Size_InternalRec_ nuclear@0: { nuclear@0: /* empty */ nuclear@0: nuclear@0: } FT_Size_InternalRec; nuclear@0: nuclear@0: #endif nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** M O D U L E S ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_ModuleRec */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* A module object instance. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* clazz :: A pointer to the module's class. */ nuclear@0: /* */ nuclear@0: /* library :: A handle to the parent library object. */ nuclear@0: /* */ nuclear@0: /* memory :: A handle to the memory manager. */ nuclear@0: /* */ nuclear@0: /* generic :: A generic structure for user-level extensibility (?). */ nuclear@0: /* */ nuclear@0: typedef struct FT_ModuleRec_ nuclear@0: { nuclear@0: FT_Module_Class* clazz; nuclear@0: FT_Library library; nuclear@0: FT_Memory memory; nuclear@0: FT_Generic generic; nuclear@0: nuclear@0: } FT_ModuleRec; nuclear@0: nuclear@0: nuclear@0: /* typecast an object to a FT_Module */ nuclear@0: #define FT_MODULE( x ) ((FT_Module)( x )) nuclear@0: #define FT_MODULE_CLASS( x ) FT_MODULE( x )->clazz nuclear@0: #define FT_MODULE_LIBRARY( x ) FT_MODULE( x )->library nuclear@0: #define FT_MODULE_MEMORY( x ) FT_MODULE( x )->memory nuclear@0: nuclear@0: nuclear@0: #define FT_MODULE_IS_DRIVER( x ) ( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_FONT_DRIVER ) nuclear@0: nuclear@0: #define FT_MODULE_IS_RENDERER( x ) ( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_RENDERER ) nuclear@0: nuclear@0: #define FT_MODULE_IS_HINTER( x ) ( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_HINTER ) nuclear@0: nuclear@0: #define FT_MODULE_IS_STYLER( x ) ( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_STYLER ) nuclear@0: nuclear@0: #define FT_DRIVER_IS_SCALABLE( x ) ( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_DRIVER_SCALABLE ) nuclear@0: nuclear@0: #define FT_DRIVER_USES_OUTLINES( x ) !( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_DRIVER_NO_OUTLINES ) nuclear@0: nuclear@0: #define FT_DRIVER_HAS_HINTER( x ) ( FT_MODULE_CLASS( x )->module_flags & \ nuclear@0: FT_MODULE_DRIVER_HAS_HINTER ) nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Get_Module_Interface */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Finds a module and returns its specific interface as a typeless */ nuclear@0: /* pointer. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* library :: A handle to the library object. */ nuclear@0: /* */ nuclear@0: /* module_name :: The module's name (as an ASCII string). */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* A module-specific interface if available, 0 otherwise. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* You should better be familiar with FreeType internals to know */ nuclear@0: /* which module to look for, and what its interface is :-) */ nuclear@0: /* */ nuclear@0: FT_BASE( const void* ) nuclear@0: FT_Get_Module_Interface( FT_Library library, nuclear@0: const char* mod_name ); nuclear@0: nuclear@0: FT_BASE( FT_Pointer ) nuclear@0: ft_module_get_service( FT_Module module, nuclear@0: const char* service_id ); nuclear@0: nuclear@0: /* */ nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** FACE, SIZE & GLYPH SLOT OBJECTS ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: /* a few macros used to perform easy typecasts with minimal brain damage */ nuclear@0: nuclear@0: #define FT_FACE( x ) ((FT_Face)(x)) nuclear@0: #define FT_SIZE( x ) ((FT_Size)(x)) nuclear@0: #define FT_SLOT( x ) ((FT_GlyphSlot)(x)) nuclear@0: nuclear@0: #define FT_FACE_DRIVER( x ) FT_FACE( x )->driver nuclear@0: #define FT_FACE_LIBRARY( x ) FT_FACE_DRIVER( x )->root.library nuclear@0: #define FT_FACE_MEMORY( x ) FT_FACE( x )->memory nuclear@0: #define FT_FACE_STREAM( x ) FT_FACE( x )->stream nuclear@0: nuclear@0: #define FT_SIZE_FACE( x ) FT_SIZE( x )->face nuclear@0: #define FT_SLOT_FACE( x ) FT_SLOT( x )->face nuclear@0: nuclear@0: #define FT_FACE_SLOT( x ) FT_FACE( x )->glyph nuclear@0: #define FT_FACE_SIZE( x ) FT_FACE( x )->size nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_New_GlyphSlot */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* It is sometimes useful to have more than one glyph slot for a */ nuclear@0: /* given face object. This function is used to create additional */ nuclear@0: /* slots. All of them are automatically discarded when the face is */ nuclear@0: /* destroyed. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* face :: A handle to a parent face object. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* aslot :: A handle to a new glyph slot object. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FreeType error code. 0 means success. */ nuclear@0: /* */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_New_GlyphSlot( FT_Face face, nuclear@0: FT_GlyphSlot *aslot ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Done_GlyphSlot */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Destroys a given glyph slot. Remember however that all slots are */ nuclear@0: /* automatically destroyed with its parent. Using this function is */ nuclear@0: /* not always mandatory. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* slot :: A handle to a target glyph slot. */ nuclear@0: /* */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Done_GlyphSlot( FT_GlyphSlot slot ); nuclear@0: nuclear@0: /* */ nuclear@0: nuclear@0: #define FT_REQUEST_WIDTH( req ) \ nuclear@0: ( (req)->horiResolution \ nuclear@0: ? (FT_Pos)( (req)->width * (req)->horiResolution + 36 ) / 72 \ nuclear@0: : (req)->width ) nuclear@0: nuclear@0: #define FT_REQUEST_HEIGHT( req ) \ nuclear@0: ( (req)->vertResolution \ nuclear@0: ? (FT_Pos)( (req)->height * (req)->vertResolution + 36 ) / 72 \ nuclear@0: : (req)->height ) nuclear@0: nuclear@0: nuclear@0: /* Set the metrics according to a bitmap strike. */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Select_Metrics( FT_Face face, nuclear@0: FT_ULong strike_index ); nuclear@0: nuclear@0: nuclear@0: /* Set the metrics according to a size request. */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Request_Metrics( FT_Face face, nuclear@0: FT_Size_Request req ); nuclear@0: nuclear@0: nuclear@0: /* Match a size request against `available_sizes'. */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Match_Size( FT_Face face, nuclear@0: FT_Size_Request req, nuclear@0: FT_Bool ignore_width, nuclear@0: FT_ULong* size_index ); nuclear@0: nuclear@0: nuclear@0: /* Use the horizontal metrics to synthesize the vertical metrics. */ nuclear@0: /* If `advance' is zero, it is also synthesized. */ nuclear@0: FT_BASE( void ) nuclear@0: ft_synthesize_vertical_metrics( FT_Glyph_Metrics* metrics, nuclear@0: FT_Pos advance ); nuclear@0: nuclear@0: nuclear@0: /* Free the bitmap of a given glyphslot when needed (i.e., only when it */ nuclear@0: /* was allocated with ft_glyphslot_alloc_bitmap). */ nuclear@0: FT_BASE( void ) nuclear@0: ft_glyphslot_free_bitmap( FT_GlyphSlot slot ); nuclear@0: nuclear@0: nuclear@0: /* Allocate a new bitmap buffer in a glyph slot. */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: ft_glyphslot_alloc_bitmap( FT_GlyphSlot slot, nuclear@0: FT_ULong size ); nuclear@0: nuclear@0: nuclear@0: /* Set the bitmap buffer in a glyph slot to a given pointer. The buffer */ nuclear@0: /* will not be freed by a later call to ft_glyphslot_free_bitmap. */ nuclear@0: FT_BASE( void ) nuclear@0: ft_glyphslot_set_bitmap( FT_GlyphSlot slot, nuclear@0: FT_Byte* buffer ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** R E N D E R E R S ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #define FT_RENDERER( x ) ((FT_Renderer)( x )) nuclear@0: #define FT_GLYPH( x ) ((FT_Glyph)( x )) nuclear@0: #define FT_BITMAP_GLYPH( x ) ((FT_BitmapGlyph)( x )) nuclear@0: #define FT_OUTLINE_GLYPH( x ) ((FT_OutlineGlyph)( x )) nuclear@0: nuclear@0: nuclear@0: typedef struct FT_RendererRec_ nuclear@0: { nuclear@0: FT_ModuleRec root; nuclear@0: FT_Renderer_Class* clazz; nuclear@0: FT_Glyph_Format glyph_format; nuclear@0: FT_Glyph_Class glyph_class; nuclear@0: nuclear@0: FT_Raster raster; nuclear@0: FT_Raster_Render_Func raster_render; nuclear@0: FT_Renderer_RenderFunc render; nuclear@0: nuclear@0: } FT_RendererRec; nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** F O N T D R I V E R S ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /* typecast a module into a driver easily */ nuclear@0: #define FT_DRIVER( x ) ((FT_Driver)(x)) nuclear@0: nuclear@0: /* typecast a module as a driver, and get its driver class */ nuclear@0: #define FT_DRIVER_CLASS( x ) FT_DRIVER( x )->clazz nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DriverRec */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* The root font driver class. A font driver is responsible for */ nuclear@0: /* managing and loading font files of a given format. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* root :: Contains the fields of the root module class. */ nuclear@0: /* */ nuclear@0: /* clazz :: A pointer to the font driver's class. Note that */ nuclear@0: /* this is NOT root.clazz. `class' wasn't used */ nuclear@0: /* as it is a reserved word in C++. */ nuclear@0: /* */ nuclear@0: /* faces_list :: The list of faces currently opened by this */ nuclear@0: /* driver. */ nuclear@0: /* */ nuclear@0: /* extensions :: A typeless pointer to the driver's extensions */ nuclear@0: /* registry, if they are supported through the */ nuclear@0: /* configuration macro FT_CONFIG_OPTION_EXTENSIONS. */ nuclear@0: /* */ nuclear@0: /* glyph_loader :: The glyph loader for all faces managed by this */ nuclear@0: /* driver. This object isn't defined for unscalable */ nuclear@0: /* formats. */ nuclear@0: /* */ nuclear@0: typedef struct FT_DriverRec_ nuclear@0: { nuclear@0: FT_ModuleRec root; nuclear@0: FT_Driver_Class clazz; nuclear@0: nuclear@0: FT_ListRec faces_list; nuclear@0: void* extensions; nuclear@0: nuclear@0: FT_GlyphLoader glyph_loader; nuclear@0: nuclear@0: } FT_DriverRec; nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** L I B R A R I E S ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /* This hook is used by the TrueType debugger. It must be set to an */ nuclear@0: /* alternate truetype bytecode interpreter function. */ nuclear@0: #define FT_DEBUG_HOOK_TRUETYPE 0 nuclear@0: nuclear@0: nuclear@0: /* Set this debug hook to a non-null pointer to force unpatented hinting */ nuclear@0: /* for all faces when both TT_USE_BYTECODE_INTERPRETER and */ nuclear@0: /* TT_CONFIG_OPTION_UNPATENTED_HINTING are defined. This is only used */ nuclear@0: /* during debugging. */ nuclear@0: #define FT_DEBUG_HOOK_UNPATENTED_HINTING 1 nuclear@0: nuclear@0: nuclear@0: typedef void (*FT_Bitmap_LcdFilterFunc)( FT_Bitmap* bitmap, nuclear@0: FT_Render_Mode render_mode, nuclear@0: FT_Library library ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_LibraryRec */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* The FreeType library class. This is the root of all FreeType */ nuclear@0: /* data. Use FT_New_Library() to create a library object, and */ nuclear@0: /* FT_Done_Library() to discard it and all child objects. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* memory :: The library's memory object. Manages memory */ nuclear@0: /* allocation. */ nuclear@0: /* */ nuclear@0: /* generic :: Client data variable. Used to extend the */ nuclear@0: /* Library class by higher levels and clients. */ nuclear@0: /* */ nuclear@0: /* version_major :: The major version number of the library. */ nuclear@0: /* */ nuclear@0: /* version_minor :: The minor version number of the library. */ nuclear@0: /* */ nuclear@0: /* version_patch :: The current patch level of the library. */ nuclear@0: /* */ nuclear@0: /* num_modules :: The number of modules currently registered */ nuclear@0: /* within this library. This is set to 0 for new */ nuclear@0: /* libraries. New modules are added through the */ nuclear@0: /* FT_Add_Module() API function. */ nuclear@0: /* */ nuclear@0: /* modules :: A table used to store handles to the currently */ nuclear@0: /* registered modules. Note that each font driver */ nuclear@0: /* contains a list of its opened faces. */ nuclear@0: /* */ nuclear@0: /* renderers :: The list of renderers currently registered */ nuclear@0: /* within the library. */ nuclear@0: /* */ nuclear@0: /* cur_renderer :: The current outline renderer. This is a */ nuclear@0: /* shortcut used to avoid parsing the list on */ nuclear@0: /* each call to FT_Outline_Render(). It is a */ nuclear@0: /* handle to the current renderer for the */ nuclear@0: /* FT_GLYPH_FORMAT_OUTLINE format. */ nuclear@0: /* */ nuclear@0: /* auto_hinter :: XXX */ nuclear@0: /* */ nuclear@0: /* raster_pool :: The raster object's render pool. This can */ nuclear@0: /* ideally be changed dynamically at run-time. */ nuclear@0: /* */ nuclear@0: /* raster_pool_size :: The size of the render pool in bytes. */ nuclear@0: /* */ nuclear@0: /* debug_hooks :: XXX */ nuclear@0: /* */ nuclear@0: /* lcd_filter :: If subpixel rendering is activated, the */ nuclear@0: /* selected LCD filter mode. */ nuclear@0: /* */ nuclear@0: /* lcd_extra :: If subpixel rendering is activated, the number */ nuclear@0: /* of extra pixels needed for the LCD filter. */ nuclear@0: /* */ nuclear@0: /* lcd_weights :: If subpixel rendering is activated, the LCD */ nuclear@0: /* filter weights, if any. */ nuclear@0: /* */ nuclear@0: /* lcd_filter_func :: If subpixel rendering is activated, the LCD */ nuclear@0: /* filtering callback function. */ nuclear@0: /* */ nuclear@0: /* pic_container :: Contains global structs and tables, instead */ nuclear@0: /* of defining them globallly. */ nuclear@0: /* */ nuclear@0: /* refcount :: A counter initialized to~1 at the time an */ nuclear@0: /* @FT_Library structure is created. */ nuclear@0: /* @FT_Reference_Library increments this counter, */ nuclear@0: /* and @FT_Done_Library only destroys a library */ nuclear@0: /* if the counter is~1, otherwise it simply */ nuclear@0: /* decrements it. */ nuclear@0: /* */ nuclear@0: typedef struct FT_LibraryRec_ nuclear@0: { nuclear@0: FT_Memory memory; /* library's memory manager */ nuclear@0: nuclear@0: FT_Generic generic; nuclear@0: nuclear@0: FT_Int version_major; nuclear@0: FT_Int version_minor; nuclear@0: FT_Int version_patch; nuclear@0: nuclear@0: FT_UInt num_modules; nuclear@0: FT_Module modules[FT_MAX_MODULES]; /* module objects */ nuclear@0: nuclear@0: FT_ListRec renderers; /* list of renderers */ nuclear@0: FT_Renderer cur_renderer; /* current outline renderer */ nuclear@0: FT_Module auto_hinter; nuclear@0: nuclear@0: FT_Byte* raster_pool; /* scan-line conversion */ nuclear@0: /* render pool */ nuclear@0: FT_ULong raster_pool_size; /* size of render pool in bytes */ nuclear@0: nuclear@0: FT_DebugHook_Func debug_hooks[4]; nuclear@0: nuclear@0: #ifdef FT_CONFIG_OPTION_SUBPIXEL_RENDERING nuclear@0: FT_LcdFilter lcd_filter; nuclear@0: FT_Int lcd_extra; /* number of extra pixels */ nuclear@0: FT_Byte lcd_weights[7]; /* filter weights, if any */ nuclear@0: FT_Bitmap_LcdFilterFunc lcd_filter_func; /* filtering callback */ nuclear@0: #endif nuclear@0: nuclear@0: #ifdef FT_CONFIG_OPTION_PIC nuclear@0: FT_PIC_Container pic_container; nuclear@0: #endif nuclear@0: nuclear@0: FT_UInt refcount; nuclear@0: nuclear@0: } FT_LibraryRec; nuclear@0: nuclear@0: nuclear@0: FT_BASE( FT_Renderer ) nuclear@0: FT_Lookup_Renderer( FT_Library library, nuclear@0: FT_Glyph_Format format, nuclear@0: FT_ListNode* node ); nuclear@0: nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Render_Glyph_Internal( FT_Library library, nuclear@0: FT_GlyphSlot slot, nuclear@0: FT_Render_Mode render_mode ); nuclear@0: nuclear@0: typedef const char* nuclear@0: (*FT_Face_GetPostscriptNameFunc)( FT_Face face ); nuclear@0: nuclear@0: typedef FT_Error nuclear@0: (*FT_Face_GetGlyphNameFunc)( FT_Face face, nuclear@0: FT_UInt glyph_index, nuclear@0: FT_Pointer buffer, nuclear@0: FT_UInt buffer_max ); nuclear@0: nuclear@0: typedef FT_UInt nuclear@0: (*FT_Face_GetGlyphNameIndexFunc)( FT_Face face, nuclear@0: FT_String* glyph_name ); nuclear@0: nuclear@0: nuclear@0: #ifndef FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_New_Memory */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Creates a new memory object. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* A pointer to the new memory object. 0 in case of error. */ nuclear@0: /* */ nuclear@0: FT_BASE( FT_Memory ) nuclear@0: FT_New_Memory( void ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Done_Memory */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Discards memory manager. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* memory :: A handle to the memory manager. */ nuclear@0: /* */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Done_Memory( FT_Memory memory ); nuclear@0: nuclear@0: #endif /* !FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM */ nuclear@0: nuclear@0: nuclear@0: /* Define default raster's interface. The default raster is located in */ nuclear@0: /* `src/base/ftraster.c'. */ nuclear@0: /* */ nuclear@0: /* Client applications can register new rasters through the */ nuclear@0: /* FT_Set_Raster() API. */ nuclear@0: nuclear@0: #ifndef FT_NO_DEFAULT_RASTER nuclear@0: FT_EXPORT_VAR( FT_Raster_Funcs ) ft_default_raster; nuclear@0: #endif nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** PIC-Support Macros for ftimage.h ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DEFINE_OUTLINE_FUNCS */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to initialize an instance of FT_Outline_Funcs struct. */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is defined an init funtion will need to */ nuclear@0: /* called with a pre-allocated stracture to be filled. */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is not defined the struct will be */ nuclear@0: /* allocated in the global scope (or the scope where the macro */ nuclear@0: /* is used). */ nuclear@0: /* */ nuclear@0: #ifndef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: #define FT_DEFINE_OUTLINE_FUNCS(class_, move_to_, line_to_, conic_to_, \ nuclear@0: cubic_to_, shift_, delta_) \ nuclear@0: static const FT_Outline_Funcs class_ = \ nuclear@0: { \ nuclear@0: move_to_, line_to_, conic_to_, cubic_to_, shift_, delta_ \ nuclear@0: }; nuclear@0: nuclear@0: #else /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: #define FT_DEFINE_OUTLINE_FUNCS(class_, move_to_, line_to_, conic_to_, \ nuclear@0: cubic_to_, shift_, delta_) \ nuclear@0: static FT_Error \ nuclear@0: Init_Class_##class_( FT_Outline_Funcs* clazz ) \ nuclear@0: { \ nuclear@0: clazz->move_to = move_to_; \ nuclear@0: clazz->line_to = line_to_; \ nuclear@0: clazz->conic_to = conic_to_; \ nuclear@0: clazz->cubic_to = cubic_to_; \ nuclear@0: clazz->shift = shift_; \ nuclear@0: clazz->delta = delta_; \ nuclear@0: return FT_Err_Ok; \ nuclear@0: } nuclear@0: nuclear@0: #endif /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DEFINE_RASTER_FUNCS */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to initialize an instance of FT_Raster_Funcs struct. */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is defined an init funtion will need to */ nuclear@0: /* called with a pre-allocated stracture to be filled. */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is not defined the struct will be */ nuclear@0: /* allocated in the global scope (or the scope where the macro */ nuclear@0: /* is used). */ nuclear@0: /* */ nuclear@0: #ifndef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: #define FT_DEFINE_RASTER_FUNCS(class_, glyph_format_, raster_new_, \ nuclear@0: raster_reset_, raster_set_mode_, \ nuclear@0: raster_render_, raster_done_) \ nuclear@0: const FT_Raster_Funcs class_ = \ nuclear@0: { \ nuclear@0: glyph_format_, raster_new_, raster_reset_, \ nuclear@0: raster_set_mode_, raster_render_, raster_done_ \ nuclear@0: }; nuclear@0: nuclear@0: #else /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: #define FT_DEFINE_RASTER_FUNCS(class_, glyph_format_, raster_new_, \ nuclear@0: raster_reset_, raster_set_mode_, raster_render_, raster_done_) \ nuclear@0: void \ nuclear@0: FT_Init_Class_##class_( FT_Raster_Funcs* clazz ) \ nuclear@0: { \ nuclear@0: clazz->glyph_format = glyph_format_; \ nuclear@0: clazz->raster_new = raster_new_; \ nuclear@0: clazz->raster_reset = raster_reset_; \ nuclear@0: clazz->raster_set_mode = raster_set_mode_; \ nuclear@0: clazz->raster_render = raster_render_; \ nuclear@0: clazz->raster_done = raster_done_; \ nuclear@0: } nuclear@0: nuclear@0: #endif /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** PIC-Support Macros for ftrender.h ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DEFINE_GLYPH */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to initialize an instance of FT_Glyph_Class struct. */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is defined an init funtion will need to */ nuclear@0: /* called with a pre-allocated stracture to be filled. */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is not defined the struct will be */ nuclear@0: /* allocated in the global scope (or the scope where the macro */ nuclear@0: /* is used). */ nuclear@0: /* */ nuclear@0: #ifndef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: #define FT_DEFINE_GLYPH(class_, size_, format_, init_, done_, copy_, \ nuclear@0: transform_, bbox_, prepare_) \ nuclear@0: FT_CALLBACK_TABLE_DEF \ nuclear@0: const FT_Glyph_Class class_ = \ nuclear@0: { \ nuclear@0: size_, format_, init_, done_, copy_, transform_, bbox_, prepare_ \ nuclear@0: }; nuclear@0: nuclear@0: #else /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: #define FT_DEFINE_GLYPH(class_, size_, format_, init_, done_, copy_, \ nuclear@0: transform_, bbox_, prepare_) \ nuclear@0: void \ nuclear@0: FT_Init_Class_##class_( FT_Glyph_Class* clazz ) \ nuclear@0: { \ nuclear@0: clazz->glyph_size = size_; \ nuclear@0: clazz->glyph_format = format_; \ nuclear@0: clazz->glyph_init = init_; \ nuclear@0: clazz->glyph_done = done_; \ nuclear@0: clazz->glyph_copy = copy_; \ nuclear@0: clazz->glyph_transform = transform_; \ nuclear@0: clazz->glyph_bbox = bbox_; \ nuclear@0: clazz->glyph_prepare = prepare_; \ nuclear@0: } nuclear@0: nuclear@0: #endif /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DECLARE_RENDERER */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to create a forward declaration of a */ nuclear@0: /* FT_Renderer_Class stract instance. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DEFINE_RENDERER */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to initialize an instance of FT_Renderer_Class struct. */ nuclear@0: /* */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is defined a Create funtion will need */ nuclear@0: /* to called with a pointer where the allocated stracture is returned.*/ nuclear@0: /* And when it is no longer needed a Destroy function needs */ nuclear@0: /* to be called to release that allocation. */ nuclear@0: /* fcinit.c (ft_create_default_module_classes) already contains */ nuclear@0: /* a mechanism to call these functions for the default modules */ nuclear@0: /* described in ftmodule.h */ nuclear@0: /* */ nuclear@0: /* Notice that the created Create and Destroy functions call */ nuclear@0: /* pic_init and pic_free function to allow you to manually allocate */ nuclear@0: /* and initialize any additional global data, like module specific */ nuclear@0: /* interface, and put them in the global pic container defined in */ nuclear@0: /* ftpic.h. if you don't need them just implement the functions as */ nuclear@0: /* empty to resolve the link error. */ nuclear@0: /* */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is not defined the struct will be */ nuclear@0: /* allocated in the global scope (or the scope where the macro */ nuclear@0: /* is used). */ nuclear@0: /* */ nuclear@0: #ifndef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: #define FT_DECLARE_RENDERER(class_) \ nuclear@0: FT_EXPORT_VAR( const FT_Renderer_Class ) class_; nuclear@0: nuclear@0: #define FT_DEFINE_RENDERER(class_, \ nuclear@0: flags_, size_, name_, version_, requires_, \ nuclear@0: interface_, init_, done_, get_interface_, \ nuclear@0: glyph_format_, render_glyph_, transform_glyph_, \ nuclear@0: get_glyph_cbox_, set_mode_, raster_class_ ) \ nuclear@0: FT_CALLBACK_TABLE_DEF \ nuclear@0: const FT_Renderer_Class class_ = \ nuclear@0: { \ nuclear@0: FT_DEFINE_ROOT_MODULE(flags_,size_,name_,version_,requires_, \ nuclear@0: interface_,init_,done_,get_interface_) \ nuclear@0: glyph_format_, \ nuclear@0: \ nuclear@0: render_glyph_, \ nuclear@0: transform_glyph_, \ nuclear@0: get_glyph_cbox_, \ nuclear@0: set_mode_, \ nuclear@0: \ nuclear@0: raster_class_ \ nuclear@0: }; nuclear@0: nuclear@0: #else /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: #define FT_DECLARE_RENDERER(class_) FT_DECLARE_MODULE(class_) nuclear@0: nuclear@0: #define FT_DEFINE_RENDERER(class_, \ nuclear@0: flags_, size_, name_, version_, requires_, \ nuclear@0: interface_, init_, done_, get_interface_, \ nuclear@0: glyph_format_, render_glyph_, transform_glyph_, \ nuclear@0: get_glyph_cbox_, set_mode_, raster_class_ ) \ nuclear@0: void class_##_pic_free( FT_Library library ); \ nuclear@0: FT_Error class_##_pic_init( FT_Library library ); \ nuclear@0: \ nuclear@0: void \ nuclear@0: FT_Destroy_Class_##class_( FT_Library library, \ nuclear@0: FT_Module_Class* clazz ) \ nuclear@0: { \ nuclear@0: FT_Renderer_Class* rclazz = (FT_Renderer_Class*)clazz; \ nuclear@0: FT_Memory memory = library->memory; \ nuclear@0: class_##_pic_free( library ); \ nuclear@0: if ( rclazz ) \ nuclear@0: FT_FREE( rclazz ); \ nuclear@0: } \ nuclear@0: \ nuclear@0: FT_Error \ nuclear@0: FT_Create_Class_##class_( FT_Library library, \ nuclear@0: FT_Module_Class** output_class ) \ nuclear@0: { \ nuclear@0: FT_Renderer_Class* clazz; \ nuclear@0: FT_Error error; \ nuclear@0: FT_Memory memory = library->memory; \ nuclear@0: \ nuclear@0: if ( FT_ALLOC( clazz, sizeof(*clazz) ) ) \ nuclear@0: return error; \ nuclear@0: \ nuclear@0: error = class_##_pic_init( library ); \ nuclear@0: if(error) \ nuclear@0: { \ nuclear@0: FT_FREE( clazz ); \ nuclear@0: return error; \ nuclear@0: } \ nuclear@0: \ nuclear@0: FT_DEFINE_ROOT_MODULE(flags_,size_,name_,version_,requires_, \ nuclear@0: interface_,init_,done_,get_interface_) \ nuclear@0: \ nuclear@0: clazz->glyph_format = glyph_format_; \ nuclear@0: \ nuclear@0: clazz->render_glyph = render_glyph_; \ nuclear@0: clazz->transform_glyph = transform_glyph_; \ nuclear@0: clazz->get_glyph_cbox = get_glyph_cbox_; \ nuclear@0: clazz->set_mode = set_mode_; \ nuclear@0: \ nuclear@0: clazz->raster_class = raster_class_; \ nuclear@0: \ nuclear@0: *output_class = (FT_Module_Class*)clazz; \ nuclear@0: return FT_Err_Ok; \ nuclear@0: } nuclear@0: nuclear@0: nuclear@0: nuclear@0: #endif /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /**** PIC-Support Macros for ftmodapi.h ****/ nuclear@0: /**** ****/ nuclear@0: /**** ****/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #ifdef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Module_Creator */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* A function used to create (allocate) a new module class object. */ nuclear@0: /* The object's members are initialized, but the module itself is */ nuclear@0: /* not. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* memory :: A handle to the memory manager. */ nuclear@0: /* output_class :: Initialized with the newly allocated class. */ nuclear@0: /* */ nuclear@0: typedef FT_Error nuclear@0: (*FT_Module_Creator)( FT_Memory memory, nuclear@0: FT_Module_Class** output_class ); nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_Module_Destroyer */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* A function used to destroy (deallocate) a module class object. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* memory :: A handle to the memory manager. */ nuclear@0: /* clazz :: Module class to destroy. */ nuclear@0: /* */ nuclear@0: typedef void nuclear@0: (*FT_Module_Destroyer)( FT_Memory memory, nuclear@0: FT_Module_Class* clazz ); nuclear@0: nuclear@0: #endif nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DECLARE_MODULE */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to create a forward declaration of a */ nuclear@0: /* FT_Module_Class stract instance. */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DEFINE_MODULE */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to initialize an instance of FT_Module_Class struct. */ nuclear@0: /* */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is defined a Create funtion will need */ nuclear@0: /* to called with a pointer where the allocated stracture is returned.*/ nuclear@0: /* And when it is no longer needed a Destroy function needs */ nuclear@0: /* to be called to release that allocation. */ nuclear@0: /* fcinit.c (ft_create_default_module_classes) already contains */ nuclear@0: /* a mechanism to call these functions for the default modules */ nuclear@0: /* described in ftmodule.h */ nuclear@0: /* */ nuclear@0: /* Notice that the created Create and Destroy functions call */ nuclear@0: /* pic_init and pic_free function to allow you to manually allocate */ nuclear@0: /* and initialize any additional global data, like module specific */ nuclear@0: /* interface, and put them in the global pic container defined in */ nuclear@0: /* ftpic.h. if you don't need them just implement the functions as */ nuclear@0: /* empty to resolve the link error. */ nuclear@0: /* */ nuclear@0: /* When FT_CONFIG_OPTION_PIC is not defined the struct will be */ nuclear@0: /* allocated in the global scope (or the scope where the macro */ nuclear@0: /* is used). */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* FT_DEFINE_ROOT_MODULE */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* Used to initialize an instance of FT_Module_Class struct inside */ nuclear@0: /* another stract that contains it or in a function that initializes */ nuclear@0: /* that containing stract */ nuclear@0: /* */ nuclear@0: #ifndef FT_CONFIG_OPTION_PIC nuclear@0: nuclear@0: #define FT_DECLARE_MODULE(class_) \ nuclear@0: FT_CALLBACK_TABLE \ nuclear@0: const FT_Module_Class class_; \ nuclear@0: nuclear@0: #define FT_DEFINE_ROOT_MODULE(flags_, size_, name_, version_, requires_, \ nuclear@0: interface_, init_, done_, get_interface_) \ nuclear@0: { \ nuclear@0: flags_, \ nuclear@0: size_, \ nuclear@0: \ nuclear@0: name_, \ nuclear@0: version_, \ nuclear@0: requires_, \ nuclear@0: \ nuclear@0: interface_, \ nuclear@0: \ nuclear@0: init_, \ nuclear@0: done_, \ nuclear@0: get_interface_, \ nuclear@0: }, nuclear@0: nuclear@0: #define FT_DEFINE_MODULE(class_, flags_, size_, name_, version_, requires_, \ nuclear@0: interface_, init_, done_, get_interface_) \ nuclear@0: FT_CALLBACK_TABLE_DEF \ nuclear@0: const FT_Module_Class class_ = \ nuclear@0: { \ nuclear@0: flags_, \ nuclear@0: size_, \ nuclear@0: \ nuclear@0: name_, \ nuclear@0: version_, \ nuclear@0: requires_, \ nuclear@0: \ nuclear@0: interface_, \ nuclear@0: \ nuclear@0: init_, \ nuclear@0: done_, \ nuclear@0: get_interface_, \ nuclear@0: }; nuclear@0: nuclear@0: nuclear@0: #else /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: #define FT_DECLARE_MODULE(class_) \ nuclear@0: FT_Error FT_Create_Class_##class_( FT_Library library, \ nuclear@0: FT_Module_Class** output_class ); \ nuclear@0: void FT_Destroy_Class_##class_( FT_Library library, \ nuclear@0: FT_Module_Class* clazz ); nuclear@0: nuclear@0: #define FT_DEFINE_ROOT_MODULE(flags_, size_, name_, version_, requires_, \ nuclear@0: interface_, init_, done_, get_interface_) \ nuclear@0: clazz->root.module_flags = flags_; \ nuclear@0: clazz->root.module_size = size_; \ nuclear@0: clazz->root.module_name = name_; \ nuclear@0: clazz->root.module_version = version_; \ nuclear@0: clazz->root.module_requires = requires_; \ nuclear@0: \ nuclear@0: clazz->root.module_interface = interface_; \ nuclear@0: \ nuclear@0: clazz->root.module_init = init_; \ nuclear@0: clazz->root.module_done = done_; \ nuclear@0: clazz->root.get_interface = get_interface_; nuclear@0: nuclear@0: #define FT_DEFINE_MODULE(class_, flags_, size_, name_, version_, requires_, \ nuclear@0: interface_, init_, done_, get_interface_) \ nuclear@0: void class_##_pic_free( FT_Library library ); \ nuclear@0: FT_Error class_##_pic_init( FT_Library library ); \ nuclear@0: \ nuclear@0: void \ nuclear@0: FT_Destroy_Class_##class_( FT_Library library, \ nuclear@0: FT_Module_Class* clazz ) \ nuclear@0: { \ nuclear@0: FT_Memory memory = library->memory; \ nuclear@0: class_##_pic_free( library ); \ nuclear@0: if ( clazz ) \ nuclear@0: FT_FREE( clazz ); \ nuclear@0: } \ nuclear@0: \ nuclear@0: FT_Error \ nuclear@0: FT_Create_Class_##class_( FT_Library library, \ nuclear@0: FT_Module_Class** output_class ) \ nuclear@0: { \ nuclear@0: FT_Memory memory = library->memory; \ nuclear@0: FT_Module_Class* clazz; \ nuclear@0: FT_Error error; \ nuclear@0: \ nuclear@0: if ( FT_ALLOC( clazz, sizeof(*clazz) ) ) \ nuclear@0: return error; \ nuclear@0: error = class_##_pic_init( library ); \ nuclear@0: if(error) \ nuclear@0: { \ nuclear@0: FT_FREE( clazz ); \ nuclear@0: return error; \ nuclear@0: } \ nuclear@0: \ nuclear@0: clazz->module_flags = flags_; \ nuclear@0: clazz->module_size = size_; \ nuclear@0: clazz->module_name = name_; \ nuclear@0: clazz->module_version = version_; \ nuclear@0: clazz->module_requires = requires_; \ nuclear@0: \ nuclear@0: clazz->module_interface = interface_; \ nuclear@0: \ nuclear@0: clazz->module_init = init_; \ nuclear@0: clazz->module_done = done_; \ nuclear@0: clazz->get_interface = get_interface_; \ nuclear@0: \ nuclear@0: *output_class = clazz; \ nuclear@0: return FT_Err_Ok; \ nuclear@0: } nuclear@0: nuclear@0: #endif /* FT_CONFIG_OPTION_PIC */ nuclear@0: nuclear@0: nuclear@0: FT_END_HEADER nuclear@0: nuclear@0: #endif /* __FTOBJS_H__ */ nuclear@0: nuclear@0: nuclear@0: /* END */