ftccache.h File Reference

#include <freetype/internal/compiler-macros.h>
#include "ftcmru.h"

Include dependency graph for ftccache.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	FTC_NodeRec_
struct	FTC_CacheClassRec_
struct	FTC_CacheRec_

Macros
#define	FTC_FACE_ID_HASH(i)    ( ( (FT_Offset)(i) >> 3 ) ^ ( (FT_Offset)(i) << 7 ) )
#define	FTC_NODE(x)   ( (FTC_Node)(x) )
#define	FTC_NODE_P(x)   ( (FTC_Node*)(x) )
#define	FTC_NODE_NEXT(x)   FTC_NODE( (x)->mru.next )
#define	FTC_NODE_PREV(x)   FTC_NODE( (x)->mru.prev )
#define	FTC_NODE_TOP_FOR_HASH(cache, hash)
#define	FTC_CACHE(x)   ( (FTC_Cache)(x) )
#define	FTC_CACHE_P(x)   ( (FTC_Cache*)(x) )
#define	FTC_CACHE_LOOKUP_CMP(cache, nodecmp, hash, query, node, error)
#define	FTC_CACHE_TRYLOOP(cache)
#define	FTC_CACHE_TRYLOOP_END(list_changed)

Typedefs
typedef struct FTC_CacheRec_ *	FTC_Cache
typedef const struct FTC_CacheClassRec_ *	FTC_CacheClass
typedef struct FTC_NodeRec_	FTC_NodeRec
typedef FT_Error(*	FTC_Node_NewFunc) (FTC_Node *pnode, FT_Pointer query, FTC_Cache cache)
typedef FT_Offset(*	FTC_Node_WeightFunc) (FTC_Node node, FTC_Cache cache)
typedef FT_Bool(*	FTC_Node_CompareFunc) (FTC_Node node, FT_Pointer key, FTC_Cache cache, FT_Bool *list_changed)
typedef void(*	FTC_Node_FreeFunc) (FTC_Node node, FTC_Cache cache)
typedef FT_Error(*	FTC_Cache_InitFunc) (FTC_Cache cache)
typedef void(*	FTC_Cache_DoneFunc) (FTC_Cache cache)
typedef struct FTC_CacheClassRec_	FTC_CacheClassRec
typedef struct FTC_CacheRec_	FTC_CacheRec

Functions
	FTC_Cache_Init (FTC_Cache cache)
	FTC_Cache_Done (FTC_Cache cache)
	FTC_Cache_NewNode (FTC_Cache cache, FT_Offset hash, FT_Pointer query, FTC_Node *anode)
	FTC_Cache_RemoveFaceID (FTC_Cache cache, FTC_FaceID face_id)

Macro Definition Documentation

FTC_CACHE

#define FTC_CACHE

(

x

)

( (FTC_Cache)(x) )

Definition at line 161 of file ftccache.h.

FTC_CACHE_LOOKUP_CMP

#define FTC_CACHE_LOOKUP_CMP	(		cache,
			nodecmp,
			hash,
			query,
			node,
			error
	)

Definition at line 210 of file ftccache.h.

FTC_CACHE_P

#define FTC_CACHE_P

(

x

)

( (FTC_Cache*)(x) )

Definition at line 162 of file ftccache.h.

FTC_CACHE_TRYLOOP

#define FTC_CACHE_TRYLOOP

(

cache

)

Value:

  {                                                          \
    FTC_Manager  _try_manager = FTC_CACHE( cache )->manager; \
    FT_UInt      _try_count   = 4;                           \
                                                             \
                                                             \
    for (;;)                                                 \
    {                                                        \
      FT_UInt  _try_done;

Definition at line 312 of file ftccache.h.

FTC_CACHE_TRYLOOP_END

#define FTC_CACHE_TRYLOOP_END

(

list_changed

)

Value:

      if ( !error || FT_ERR_NEQ( error, Out_Of_Memory ) )         \
        break;                                                    \
                                                                  \
      _try_done = FTC_Manager_FlushN( _try_manager, _try_count ); \
      if ( _try_done > 0 && list_changed != NULL )                \
        *(FT_Bool*)( list_changed ) = TRUE;                       \
                                                                  \
      if ( _try_done == 0 )                                       \
        break;                                                    \
                                                                  \
      if ( _try_done == _try_count )                              \
      {                                                           \
        _try_count *= 2;                                          \
        if ( _try_count < _try_done              ||               \
            _try_count > _try_manager->num_nodes )                \
          _try_count = _try_manager->num_nodes;                   \
      }                                                           \
    }                                                             \
  }

Definition at line 323 of file ftccache.h.

FTC_FACE_ID_HASH

#define FTC_FACE_ID_HASH

(

i

)

( ( (FT_Offset)(i) >> 3 ) ^ ( (FT_Offset)(i) << 7 ) )

Definition at line 27 of file ftccache.h.

FTC_NODE

#define FTC_NODE

(

x

)

( (FTC_Node)(x) )

Definition at line 69 of file ftccache.h.

FTC_NODE_NEXT

#define FTC_NODE_NEXT

(

x

)

FTC_NODE( (x)->mru.next )

Definition at line 72 of file ftccache.h.

FTC_NODE_P

#define FTC_NODE_P

(

x

)

( (FTC_Node*)(x) )

Definition at line 70 of file ftccache.h.

FTC_NODE_PREV

#define FTC_NODE_PREV

(

x

)

FTC_NODE( (x)->mru.prev )

Definition at line 73 of file ftccache.h.

FTC_NODE_TOP_FOR_HASH

#define FTC_NODE_TOP_FOR_HASH	(		cache,
			hash
	)

Value:

        ( ( cache )->buckets +                                    \
            ( ( ( ( hash ) &   ( cache )->mask ) < ( cache )->p ) \
              ? ( ( hash ) & ( ( cache )->mask * 2 + 1 ) )        \
              : ( ( hash ) &   ( cache )->mask ) ) )

Definition at line 76 of file ftccache.h.

Typedef Documentation

FTC_Cache

typedef struct FTC_CacheRec_* FTC_Cache

Definition at line 31 of file ftccache.h.

FTC_Cache_DoneFunc

typedef void(* FTC_Cache_DoneFunc) (FTC_Cache cache)

Definition at line 123 of file ftccache.h.

FTC_Cache_InitFunc

typedef FT_Error(* FTC_Cache_InitFunc) (FTC_Cache cache)

Definition at line 120 of file ftccache.h.

FTC_CacheClass

typedef const struct FTC_CacheClassRec_* FTC_CacheClass

Definition at line 34 of file ftccache.h.

FTC_CacheClassRec

typedef struct FTC_CacheClassRec_ FTC_CacheClassRec

FTC_CacheRec

typedef struct FTC_CacheRec_ FTC_CacheRec

FTC_Node_CompareFunc

typedef FT_Bool(* FTC_Node_CompareFunc) (FTC_Node node, FT_Pointer key, FTC_Cache cache, FT_Bool *list_changed)

Definition at line 109 of file ftccache.h.

FTC_Node_FreeFunc

typedef void(* FTC_Node_FreeFunc) (FTC_Node node, FTC_Cache cache)

Definition at line 116 of file ftccache.h.

FTC_Node_NewFunc

typedef FT_Error(* FTC_Node_NewFunc) (FTC_Node *pnode, FT_Pointer query, FTC_Cache cache)

Definition at line 99 of file ftccache.h.

FTC_Node_WeightFunc

typedef FT_Offset(* FTC_Node_WeightFunc) (FTC_Node node, FTC_Cache cache)

Definition at line 104 of file ftccache.h.

FTC_NodeRec

typedef struct FTC_NodeRec_ FTC_NodeRec

Function Documentation

FTC_Cache_Done()

FTC_Cache_Done

(

FTC_Cache

cache

)

Definition at line 408 of file ftccache.c.

  {
    ftc_cache_done( cache );
  }

Referenced by ftc_gcache_done().

FTC_Cache_Init()

FTC_Cache_Init

(

FTC_Cache

cache

)

Definition at line 327 of file ftccache.c.

  {
    return ftc_cache_init( cache );
  }

Referenced by ftc_gcache_init().

FTC_Cache_NewNode()

FTC_Cache_NewNode	(	FTC_Cache	cache,
		FT_Offset	hash,
		FT_Pointer	query,
		FTC_Node *	anode
	)

Definition at line 443 of file ftccache.c.

  {
    FT_Error  error;
    FTC_Node  node;
 
 
    /*
     * We use the FTC_CACHE_TRYLOOP macros to support out-of-memory
     * errors (OOM) correctly, i.e., by flushing the cache progressively
     * in order to make more room.
     */
 
    FTC_CACHE_TRYLOOP( cache )
    {
      error = cache->clazz.node_new( &node, query, cache );
    }
    FTC_CACHE_TRYLOOP_END( NULL );
 
    if ( error )
      node = NULL;
    else
    {
     /* don't assume that the cache has the same number of buckets, since
      * our allocation request might have triggered global cache flushing
      */
      ftc_cache_add( cache, hash, node );
    }
 
    *anode = node;
    return error;
  }

FTC_Cache_RemoveFaceID()

FTC_Cache_RemoveFaceID	(	FTC_Cache	cache,
		FTC_FaceID	face_id
	)

Definition at line 563 of file ftccache.c.

  {
    FT_UFast     i, count;
    FTC_Manager  manager = cache->manager;
    FTC_Node     frees   = NULL;
 
 
    count = cache->p + cache->mask + 1;
    for ( i = 0; i < count; i++ )
    {
      FTC_Node*  bucket = cache->buckets + i;
      FTC_Node*  pnode  = bucket;
 
 
      for (;;)
      {
        FTC_Node  node = *pnode;
        FT_Bool   list_changed = FALSE;
 
 
        if ( !node )
          break;
 
        if ( cache->clazz.node_remove_faceid( node, face_id,
                                              cache, &list_changed ) )
        {
          *pnode     = node->link;
          node->link = frees;
          frees      = node;
        }
        else
          pnode = &node->link;
      }
    }
 
    /* remove all nodes in the free list */
    while ( frees )
    {
      FTC_Node  node;
 
 
      node  = frees;
      frees = node->link;
 
      manager->cur_weight -= cache->clazz.node_weight( node, cache );
      ftc_node_mru_unlink( node, manager );
 
      cache->clazz.node_free( node, cache );
 
      cache->slack++;
    }
 
    ftc_cache_resize( cache );
  }

Referenced by FTC_Manager_RemoveFaceID().