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