ftmodapi.h File Reference

#include <ft2build.h>

Include dependency graph for ftmodapi.h:

Go to the source code of this file.

Classes
struct	FT_Module_Class_

Macros
#define	FT_MODULE_FONT_DRIVER   1 /* this module is a font driver */
#define	FT_MODULE_RENDERER   2 /* this module is a renderer */
#define	FT_MODULE_HINTER   4 /* this module is a glyph hinter */
#define	FT_MODULE_STYLER   8 /* this module is a styler */
#define	FT_MODULE_DRIVER_SCALABLE   0x100 /* the driver supports */
#define	FT_MODULE_DRIVER_NO_OUTLINES   0x200 /* the driver does not */
#define	FT_MODULE_DRIVER_HAS_HINTER   0x400 /* the driver provides its */
#define	FT_MODULE_DRIVER_HINTS_LIGHTLY   0x800 /* the driver's hinter */
#define	ft_module_font_driver   FT_MODULE_FONT_DRIVER
#define	ft_module_renderer   FT_MODULE_RENDERER
#define	ft_module_hinter   FT_MODULE_HINTER
#define	ft_module_styler   FT_MODULE_STYLER
#define	ft_module_driver_scalable   FT_MODULE_DRIVER_SCALABLE
#define	ft_module_driver_no_outlines   FT_MODULE_DRIVER_NO_OUTLINES
#define	ft_module_driver_has_hinter   FT_MODULE_DRIVER_HAS_HINTER
#define	ft_module_driver_hints_lightly   FT_MODULE_DRIVER_HINTS_LIGHTLY

Typedefs
typedef FT_Pointer	FT_Module_Interface
typedef FT_Error(*	FT_Module_Constructor) (FT_Module module)
typedef void(*	FT_Module_Destructor) (FT_Module module)
typedef FT_Module_Interface(*	FT_Module_Requester) (FT_Module module, const char *name)
typedef struct FT_Module_Class_	FT_Module_Class
typedef void(*	FT_DebugHook_Func) (void *arg)
typedef enum FT_TrueTypeEngineType_	FT_TrueTypeEngineType

Enumerations
enum	FT_TrueTypeEngineType_ { FT_TRUETYPE_ENGINE_TYPE_NONE = 0 , FT_TRUETYPE_ENGINE_TYPE_UNPATENTED , FT_TRUETYPE_ENGINE_TYPE_PATENTED }

Functions
	FT_Add_Module (FT_Library library, const FT_Module_Class *clazz)
	FT_Get_Module (FT_Library library, const char *module_name)
	FT_Remove_Module (FT_Library library, FT_Module module)
	FT_Property_Set (FT_Library library, const FT_String *module_name, const FT_String *property_name, const void *value)
	FT_Property_Get (FT_Library library, const FT_String *module_name, const FT_String *property_name, void *value)
	FT_Set_Default_Properties (FT_Library library)
	FT_Reference_Library (FT_Library library)
	FT_New_Library (FT_Memory memory, FT_Library *alibrary)
	FT_Done_Library (FT_Library library)
	FT_Set_Debug_Hook (FT_Library library, FT_UInt hook_index, FT_DebugHook_Func debug_hook)
	FT_Add_Default_Modules (FT_Library library)
	FT_Get_TrueType_Engine_Type (FT_Library library)

Macro Definition Documentation

FT_MODULE_DRIVER_HAS_HINTER

#define FT_MODULE_DRIVER_HAS_HINTER   0x400 /* the driver provides its */

Definition at line 119 of file ftmodapi.h.

ft_module_driver_has_hinter

#define ft_module_driver_has_hinter   FT_MODULE_DRIVER_HAS_HINTER

Definition at line 133 of file ftmodapi.h.

FT_MODULE_DRIVER_HINTS_LIGHTLY

#define FT_MODULE_DRIVER_HINTS_LIGHTLY   0x800 /* the driver's hinter */

Definition at line 121 of file ftmodapi.h.

ft_module_driver_hints_lightly

#define ft_module_driver_hints_lightly   FT_MODULE_DRIVER_HINTS_LIGHTLY

Definition at line 134 of file ftmodapi.h.

FT_MODULE_DRIVER_NO_OUTLINES

#define FT_MODULE_DRIVER_NO_OUTLINES   0x200 /* the driver does not */

Definition at line 117 of file ftmodapi.h.

ft_module_driver_no_outlines

#define ft_module_driver_no_outlines   FT_MODULE_DRIVER_NO_OUTLINES

Definition at line 132 of file ftmodapi.h.

FT_MODULE_DRIVER_SCALABLE

#define FT_MODULE_DRIVER_SCALABLE   0x100 /* the driver supports */

Definition at line 115 of file ftmodapi.h.

ft_module_driver_scalable

#define ft_module_driver_scalable   FT_MODULE_DRIVER_SCALABLE

Definition at line 131 of file ftmodapi.h.

FT_MODULE_FONT_DRIVER

#define FT_MODULE_FONT_DRIVER   1 /* this module is a font driver */

Definition at line 110 of file ftmodapi.h.

ft_module_font_driver

#define ft_module_font_driver   FT_MODULE_FONT_DRIVER

Definition at line 126 of file ftmodapi.h.

FT_MODULE_HINTER

#define FT_MODULE_HINTER   4 /* this module is a glyph hinter */

Definition at line 112 of file ftmodapi.h.

ft_module_hinter

#define ft_module_hinter   FT_MODULE_HINTER

Definition at line 128 of file ftmodapi.h.

FT_MODULE_RENDERER

#define FT_MODULE_RENDERER   2 /* this module is a renderer */

Definition at line 111 of file ftmodapi.h.

ft_module_renderer

#define ft_module_renderer   FT_MODULE_RENDERER

Definition at line 127 of file ftmodapi.h.

FT_MODULE_STYLER

#define FT_MODULE_STYLER   8 /* this module is a styler */

Definition at line 113 of file ftmodapi.h.

ft_module_styler

#define ft_module_styler   FT_MODULE_STYLER

Definition at line 129 of file ftmodapi.h.

Typedef Documentation

FT_DebugHook_Func

typedef void(* FT_DebugHook_Func) (void *arg)

Definition at line 572 of file ftmodapi.h.

FT_Module_Class

typedef struct FT_Module_Class_ FT_Module_Class

FT_Module_Constructor

typedef FT_Error(* FT_Module_Constructor) (FT_Module module)

Definition at line 151 of file ftmodapi.h.

FT_Module_Destructor

typedef void(* FT_Module_Destructor) (FT_Module module)

Definition at line 166 of file ftmodapi.h.

FT_Module_Interface

typedef FT_Pointer FT_Module_Interface

Definition at line 137 of file ftmodapi.h.

FT_Module_Requester

typedef FT_Module_Interface(* FT_Module_Requester) (FT_Module module, const char *name)

Definition at line 183 of file ftmodapi.h.

FT_TrueTypeEngineType

typedef enum FT_TrueTypeEngineType_ FT_TrueTypeEngineType

Enumeration Type Documentation

FT_TrueTypeEngineType_

enum FT_TrueTypeEngineType_

Enumerator
FT_TRUETYPE_ENGINE_TYPE_NONE
FT_TRUETYPE_ENGINE_TYPE_UNPATENTED
FT_TRUETYPE_ENGINE_TYPE_PATENTED

Definition at line 671 of file ftmodapi.h.

  {
    FT_TRUETYPE_ENGINE_TYPE_NONE = 0,
    FT_TRUETYPE_ENGINE_TYPE_UNPATENTED,
    FT_TRUETYPE_ENGINE_TYPE_PATENTED
 
  } FT_TrueTypeEngineType;

Function Documentation

FT_Add_Default_Modules()

FT_Add_Default_Modules

(

FT_Library

library

)

Definition at line 198 of file ftinit.c.

  {
    FT_Error                       error;
    const FT_Module_Class* const*  cur;
 
 
    /* FT_DEFAULT_MODULES_GET dereferences `library' in PIC mode */
#ifdef FT_CONFIG_OPTION_PIC
    if ( !library )
      return;
#endif
 
    /* GCC 4.6 warns the type difference:
     *   FT_Module_Class** != const FT_Module_Class* const*
     */
    cur = (const FT_Module_Class* const*)FT_DEFAULT_MODULES_GET;
 
    /* test for valid `library' delayed to FT_Add_Module() */
    while ( *cur )
    {
      error = FT_Add_Module( library, *cur );
      /* notify errors, but don't stop */
      if ( error )
        FT_TRACE0(( "FT_Add_Default_Module:"
                    " Cannot install `%s', error = 0x%x\n",
                    (*cur)->module_name, error ));
      cur++;
    }
  }

Referenced by FT_Init_FreeType().

FT_Add_Module()

FT_Add_Module	(	FT_Library	library,
		const FT_Module_Class *	clazz
	)

Definition at line 4724 of file ftobjs.c.

  {
    FT_Error   error;
    FT_Memory  memory;
    FT_Module  module = NULL;
    FT_UInt    nn;
 
 
#define FREETYPE_VER_FIXED  ( ( (FT_Long)FREETYPE_MAJOR << 16 ) | \
                                FREETYPE_MINOR                  )
 
    if ( !library )
      return FT_THROW( Invalid_Library_Handle );
 
    if ( !clazz )
      return FT_THROW( Invalid_Argument );
 
    /* check FreeType version */
    if ( clazz->module_requires > FREETYPE_VER_FIXED )
      return FT_THROW( Invalid_Version );
 
    /* look for a module with the same name in the library's table */
    for ( nn = 0; nn < library->num_modules; nn++ )
    {
      module = library->modules[nn];
      if ( ft_strcmp( module->clazz->module_name, clazz->module_name ) == 0 )
      {
        /* this installed module has the same name, compare their versions */
        if ( clazz->module_version <= module->clazz->module_version )
          return FT_THROW( Lower_Module_Version );
 
        /* remove the module from our list, then exit the loop to replace */
        /* it by our new version..                                        */
        FT_Remove_Module( library, module );
        break;
      }
    }
 
    memory = library->memory;
    error  = FT_Err_Ok;
 
    if ( library->num_modules >= FT_MAX_MODULES )
    {
      error = FT_THROW( Too_Many_Drivers );
      goto Exit;
    }
 
    /* allocate module object */
    if ( FT_ALLOC( module, clazz->module_size ) )
      goto Exit;
 
    /* base initialization */
    module->library = library;
    module->memory  = memory;
    module->clazz   = (FT_Module_Class*)clazz;
 
    /* check whether the module is a renderer - this must be performed */
    /* before the normal module initialization                         */
    if ( FT_MODULE_IS_RENDERER( module ) )
    {
      /* add to the renderers list */
      error = ft_add_renderer( module );
      if ( error )
        goto Fail;
    }
 
    /* is the module a auto-hinter? */
    if ( FT_MODULE_IS_HINTER( module ) )
      library->auto_hinter = module;
 
    /* if the module is a font driver */
    if ( FT_MODULE_IS_DRIVER( module ) )
    {
      FT_Driver  driver = FT_DRIVER( module );
 
 
      driver->clazz = (FT_Driver_Class)module->clazz;
    }
 
    if ( clazz->module_init )
    {
      error = clazz->module_init( module );
      if ( error )
        goto Fail;
    }
 
    /* add module to the library's table */
    library->modules[library->num_modules++] = module;
 
  Exit:
    return error;
 
  Fail:
    if ( FT_MODULE_IS_RENDERER( module ) )
    {
      FT_Renderer  renderer = FT_RENDERER( module );
 
 
      if ( renderer->clazz                                          &&
           renderer->clazz->glyph_format == FT_GLYPH_FORMAT_OUTLINE &&
           renderer->raster                                         )
        renderer->clazz->raster_class->raster_done( renderer->raster );
    }
 
    FT_FREE( module );
    goto Exit;
  }

Referenced by FT_Add_Default_Modules().

FT_Done_Library()

FT_Done_Library

(

FT_Library

library

)

Definition at line 5220 of file ftobjs.c.

  {
    FT_Memory  memory;
 
 
    if ( !library )
      return FT_THROW( Invalid_Library_Handle );
 
    library->refcount--;
    if ( library->refcount > 0 )
      goto Exit;
 
    memory = library->memory;
 
    /*
     * Close all faces in the library.  If we don't do this, we can have
     * some subtle memory leaks.
     *
     * Example:
     *
     *  - the cff font driver uses the pshinter module in cff_size_done
     *  - if the pshinter module is destroyed before the cff font driver,
     *    opened FT_Face objects managed by the driver are not properly
     *    destroyed, resulting in a memory leak
     *
     * Some faces are dependent on other faces, like Type42 faces that
     * depend on TrueType faces synthesized internally.
     *
     * The order of drivers should be specified in driver_name[].
     */
    {
      FT_UInt      m, n;
      const char*  driver_name[] = { "type42", NULL };
 
 
      for ( m = 0;
            m < sizeof ( driver_name ) / sizeof ( driver_name[0] );
            m++ )
      {
        for ( n = 0; n < library->num_modules; n++ )
        {
          FT_Module    module      = library->modules[n];
          const char*  module_name = module->clazz->module_name;
          FT_List      faces;
 
 
          if ( driver_name[m]                                &&
               ft_strcmp( module_name, driver_name[m] ) != 0 )
            continue;
 
          if ( ( module->clazz->module_flags & FT_MODULE_FONT_DRIVER ) == 0 )
            continue;
 
          FT_TRACE7(( "FT_Done_Library: close faces for %s\n", module_name ));
 
          faces = &FT_DRIVER( module )->faces_list;
          while ( faces->head )
          {
            FT_Done_Face( FT_FACE( faces->head->data ) );
            if ( faces->head )
              FT_TRACE0(( "FT_Done_Library: failed to free some faces\n" ));
          }
        }
      }
    }
 
    /* Close all other modules in the library */
#if 1
    /* XXX Modules are removed in the reversed order so that  */
    /* type42 module is removed before truetype module.  This */
    /* avoids double free in some occasions.  It is a hack.   */
    while ( library->num_modules > 0 )
      FT_Remove_Module( library,
                        library->modules[library->num_modules - 1] );
#else
    {
      FT_UInt  n;
 
 
      for ( n = 0; n < library->num_modules; n++ )
      {
        FT_Module  module = library->modules[n];
 
 
        if ( module )
        {
          Destroy_Module( module );
          library->modules[n] = NULL;
        }
      }
    }
#endif
 
#ifdef FT_CONFIG_OPTION_PIC
    /* Destroy pic container contents */
    ft_pic_container_destroy( library );
#endif
 
    FT_FREE( library );
 
  Exit:
    return FT_Err_Ok;
  }

Referenced by FreeFontSupport(), and FT_Done_FreeType().

FT_Get_Module()

FT_Get_Module	(	FT_Library	library,
		const char *	module_name
	)

Definition at line 4837 of file ftobjs.c.

  {
    FT_Module   result = NULL;
    FT_Module*  cur;
    FT_Module*  limit;
 
 
    if ( !library || !module_name )
      return result;
 
    cur   = library->modules;
    limit = cur + library->num_modules;
 
    for ( ; cur < limit; cur++ )
      if ( ft_strcmp( cur[0]->clazz->module_name, module_name ) == 0 )
      {
        result = cur[0];
        break;
      }
 
    return result;
  }

Referenced by cff_get_glyph_name(), cff_get_interface(), cff_get_name_index(), cff_size_get_globals_funcs(), cff_slot_init(), cid_size_get_globals_funcs(), cid_slot_init(), FT_DEFINE_SERVICE_PSINFOREC(), FT_Get_Module_Interface(), FT_Get_TrueType_Engine_Type(), if(), sfnt_init_face(), T1_GlyphSlot_Init(), T1_Size_Get_Globals_Funcs(), T42_Driver_Init(), T42_Face_Init(), and tt_get_interface().

FT_Get_TrueType_Engine_Type()

FT_Get_TrueType_Engine_Type

(

FT_Library

library

)

Definition at line 5342 of file ftobjs.c.

  {
    FT_TrueTypeEngineType  result = FT_TRUETYPE_ENGINE_TYPE_NONE;
 
 
    if ( library )
    {
      FT_Module  module = FT_Get_Module( library, "truetype" );
 
 
      if ( module )
      {
        FT_Service_TrueTypeEngine  service;
 
 
        service = (FT_Service_TrueTypeEngine)
                    ft_module_get_service( module,
                                           FT_SERVICE_ID_TRUETYPE_ENGINE,
                                           0 );
        if ( service )
          result = service->engine_type;
      }
    }
 
    return result;
  }

FT_New_Library()

FT_New_Library	(	FT_Memory	memory,
		FT_Library *	alibrary
	)

Definition at line 5138 of file ftobjs.c.

  {
    FT_Library  library = NULL;
    FT_Error    error;
 
 
    if ( !memory || !alibrary )
      return FT_THROW( Invalid_Argument );
 
#ifdef FT_DEBUG_LEVEL_ERROR
    /* init debugging support */
    ft_debug_init();
#endif
 
    /* first of all, allocate the library object */
    if ( FT_NEW( library ) )
      return error;
 
    library->memory = memory;
 
#ifdef FT_CONFIG_OPTION_PIC
    /* initialize position independent code containers */
    error = ft_pic_container_init( library );
    if ( error )
      goto Fail;
#endif
 
    library->version_major = FREETYPE_MAJOR;
    library->version_minor = FREETYPE_MINOR;
    library->version_patch = FREETYPE_PATCH;
 
    library->refcount = 1;
 
    /* That's ok now */
    *alibrary = library;
 
    return FT_Err_Ok;
 
#ifdef FT_CONFIG_OPTION_PIC
  Fail:
    ft_pic_container_destroy( library );
    FT_FREE( library );
    return error;
#endif
  }

Referenced by FT_Init_FreeType().

FT_Property_Get()

FT_Property_Get	(	FT_Library	library,
		const FT_String *	module_name,
		const FT_String *	property_name,
		void *	value
	)

Definition at line 5072 of file ftobjs.c.

  {
    return ft_property_do( library,
                           module_name,
                           property_name,
                           value,
                           FALSE,
                           FALSE );
  }

FT_Property_Set()

FT_Property_Set	(	FT_Library	library,
		const FT_String *	module_name,
		const FT_String *	property_name,
		const void *	value
	)

Definition at line 5055 of file ftobjs.c.

  {
    return ft_property_do( library,
                           module_name,
                           property_name,
                           (void*)value,
                           TRUE,
                           FALSE );
  }

FT_Reference_Library()

FT_Reference_Library

(

FT_Library

library

)

Definition at line 5124 of file ftobjs.c.

  {
    if ( !library )
      return FT_THROW( Invalid_Library_Handle );
 
    library->refcount++;
 
    return FT_Err_Ok;
  }

FT_Remove_Module()

FT_Remove_Module	(	FT_Library	library,
		FT_Module	module
	)

Definition at line 4927 of file ftobjs.c.

  {
    /* try to find the module from the table, then remove it from there */
 
    if ( !library )
      return FT_THROW( Invalid_Library_Handle );
 
    if ( module )
    {
      FT_Module*  cur   = library->modules;
      FT_Module*  limit = cur + library->num_modules;
 
 
      for ( ; cur < limit; cur++ )
      {
        if ( cur[0] == module )
        {
          /* remove it from the table */
          library->num_modules--;
          limit--;
          while ( cur < limit )
          {
            cur[0] = cur[1];
            cur++;
          }
          limit[0] = NULL;
 
          /* destroy the module */
          Destroy_Module( module );
 
          return FT_Err_Ok;
        }
      }
    }
    return FT_THROW( Invalid_Driver_Handle );
  }

Referenced by FT_Add_Module(), and FT_Done_Library().

FT_Set_Debug_Hook()

FT_Set_Debug_Hook	(	FT_Library	library,
		FT_UInt	hook_index,
		FT_DebugHook_Func	debug_hook
	)

Definition at line 5328 of file ftobjs.c.

  {
    if ( library && debug_hook &&
         hook_index <
           ( sizeof ( library->debug_hooks ) / sizeof ( void* ) ) )
      library->debug_hooks[hook_index] = debug_hook;
  }

FT_Set_Default_Properties()

FT_Set_Default_Properties

(

FT_Library

library

)

Definition at line 309 of file ftinit.c.

  {
    FT_UNUSED( library );
  }

Referenced by FT_Init_FreeType().