ftcmru.h File Reference

#include <ft2build.h>

Include dependency graph for ftcmru.h:

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

Go to the source code of this file.

Classes
struct	FTC_MruNodeRec_
struct	FTC_MruListClassRec_
struct	FTC_MruListRec_

Macros
#define	xxFT_DEBUG_ERROR
#define	FTC_INLINE
#define	FTC_MRULIST_LOOKUP_CMP(list, key, compare, node, error)
#define	FTC_MRULIST_LOOKUP(list, key, node, error)   FTC_MRULIST_LOOKUP_CMP( list, key, (list)->clazz.node_compare, node, error )
#define	FTC_MRULIST_LOOP(list, node)
#define	FTC_MRULIST_LOOP_END()

Typedefs
typedef typedefFT_BEGIN_HEADER struct FTC_MruNodeRec_ *	FTC_MruNode
typedef struct FTC_MruNodeRec_	FTC_MruNodeRec
typedef struct FTC_MruListRec_ *	FTC_MruList
typedef struct FTC_MruListClassRec_ const *	FTC_MruListClass
typedef FT_Bool(*	FTC_MruNode_CompareFunc) (FTC_MruNode node, FT_Pointer key)
typedef FT_Error(*	FTC_MruNode_InitFunc) (FTC_MruNode node, FT_Pointer key, FT_Pointer data)
typedef FT_Error(*	FTC_MruNode_ResetFunc) (FTC_MruNode node, FT_Pointer key, FT_Pointer data)
typedef void(*	FTC_MruNode_DoneFunc) (FTC_MruNode node, FT_Pointer data)
typedef struct FTC_MruListClassRec_	FTC_MruListClassRec
typedef struct FTC_MruListRec_	FTC_MruListRec

Functions
	FTC_MruNode_Prepend (FTC_MruNode *plist, FTC_MruNode node)
	FTC_MruNode_Up (FTC_MruNode *plist, FTC_MruNode node)
	FTC_MruNode_Remove (FTC_MruNode *plist, FTC_MruNode node)
	FTC_MruList_Init (FTC_MruList list, FTC_MruListClass clazz, FT_UInt max_nodes, FT_Pointer data, FT_Memory memory)
	FTC_MruList_Reset (FTC_MruList list)
	FTC_MruList_Done (FTC_MruList list)
	FTC_MruList_New (FTC_MruList list, FT_Pointer key, FTC_MruNode *anode)
	FTC_MruList_Remove (FTC_MruList list, FTC_MruNode node)
	FTC_MruList_RemoveSelection (FTC_MruList list, FTC_MruNode_CompareFunc selection, FT_Pointer key)

Macro Definition Documentation

FTC_INLINE

#define FTC_INLINE

Definition at line 57 of file ftcmru.h.

FTC_MRULIST_LOOKUP

#define FTC_MRULIST_LOOKUP	(		list,
			key,
			node,
			error
	)		FTC_MRULIST_LOOKUP_CMP( list, key, (list)->clazz.node_compare, node, error )

Definition at line 198 of file ftcmru.h.

FTC_MRULIST_LOOKUP_CMP

#define FTC_MRULIST_LOOKUP_CMP	(		list,
			key,
			compare,
			node,
			error
	)

Definition at line 164 of file ftcmru.h.

FTC_MRULIST_LOOP

#define FTC_MRULIST_LOOP	(		list,
			node
	)

Value:

FT_BEGIN_STMNT                              \
    FTC_MruNode  _first = (list)->nodes;      \
                                              \
                                              \
    if ( _first )                             \
    {                                         \
      FTC_MruNode  _node = _first;            \
                                              \
                                              \
      do                                      \
      {                                       \
        *(FTC_MruNode*)&(node) = _node;

Definition at line 218 of file ftcmru.h.

FTC_MRULIST_LOOP_END

#define FTC_MRULIST_LOOP_END

(

)

Value:

_node = _node->next;                 \
                                             \
      } while ( _node != _first );           \
    }                                        \
  FT_END_STMNT

Definition at line 233 of file ftcmru.h.

xxFT_DEBUG_ERROR

#define xxFT_DEBUG_ERROR

Definition at line 56 of file ftcmru.h.

Typedef Documentation

FTC_MruList

typedef struct FTC_MruListRec_* FTC_MruList

Definition at line 84 of file ftcmru.h.

FTC_MruListClass

typedef struct FTC_MruListClassRec_ const* FTC_MruListClass

Definition at line 86 of file ftcmru.h.

FTC_MruListClassRec

typedef struct FTC_MruListClassRec_ FTC_MruListClassRec

FTC_MruListRec

typedef struct FTC_MruListRec_ FTC_MruListRec

FTC_MruNode

typedef typedefFT_BEGIN_HEADER struct FTC_MruNodeRec_* FTC_MruNode

Definition at line 61 of file ftcmru.h.

FTC_MruNode_CompareFunc

typedef FT_Bool(* FTC_MruNode_CompareFunc) (FTC_MruNode node, FT_Pointer key)

Definition at line 90 of file ftcmru.h.

FTC_MruNode_DoneFunc

typedef void(* FTC_MruNode_DoneFunc) (FTC_MruNode node, FT_Pointer data)

Definition at line 104 of file ftcmru.h.

FTC_MruNode_InitFunc

typedef FT_Error(* FTC_MruNode_InitFunc) (FTC_MruNode node, FT_Pointer key, FT_Pointer data)

Definition at line 94 of file ftcmru.h.

FTC_MruNode_ResetFunc

typedef FT_Error(* FTC_MruNode_ResetFunc) (FTC_MruNode node, FT_Pointer key, FT_Pointer data)

Definition at line 99 of file ftcmru.h.

FTC_MruNodeRec

typedef struct FTC_MruNodeRec_ FTC_MruNodeRec

Function Documentation

FTC_MruList_Done()

FTC_MruList_Done

(

FTC_MruList

list

)

Definition at line 195 of file ftcmru.c.

  {
    FTC_MruList_Reset( list );
  }

Referenced by ftc_gcache_done(), and FTC_Manager_Done().

FTC_MruList_Init()

FTC_MruList_Init	(	FTC_MruList	list,
		FTC_MruListClass	clazz,
		FT_UInt	max_nodes,
		FT_Pointer	data,
		FT_Memory	memory
	)

Definition at line 169 of file ftcmru.c.

  {
    list->num_nodes = 0;
    list->max_nodes = max_nodes;
    list->nodes     = NULL;
    list->clazz     = *clazz;
    list->data      = data;
    list->memory    = memory;
  }

Referenced by ftc_gcache_init(), and FTC_Manager_New().

FTC_MruList_New()

FTC_MruList_New	(	FTC_MruList	list,
		FT_Pointer	key,
		FTC_MruNode *	anode
	)

Definition at line 236 of file ftcmru.c.

  {
    FT_Error     error;
    FTC_MruNode  node   = NULL;
    FT_Memory    memory = list->memory;


    if ( list->num_nodes >= list->max_nodes && list->max_nodes > 0 )
    {
      node = list->nodes->prev;

      FT_ASSERT( node );

      if ( list->clazz.node_reset )
      {
        FTC_MruNode_Up( &list->nodes, node );

        error = list->clazz.node_reset( node, key, list->data );
        if ( !error )
          goto Exit;
      }

      FTC_MruNode_Remove( &list->nodes, node );
      list->num_nodes--;

      if ( list->clazz.node_done )
        list->clazz.node_done( node, list->data );
    }
    else if ( FT_ALLOC( node, list->clazz.node_size ) )
      goto Exit;

    error = list->clazz.node_init( node, key, list->data );
    if ( error )
      goto Fail;

    FTC_MruNode_Prepend( &list->nodes, node );
    list->num_nodes++;

  Exit:
    *anode = node;
    return error;

  Fail:
    if ( list->clazz.node_done )
      list->clazz.node_done( node, list->data );

    FT_FREE( node );
    goto Exit;
  }

FTC_MruList_Remove()

FTC_MruList_Remove	(	FTC_MruList	list,
		FTC_MruNode	node
	)

Definition at line 308 of file ftcmru.c.

  {
    FTC_MruNode_Remove( &list->nodes, node );
    list->num_nodes--;

    {
      FT_Memory  memory = list->memory;


      if ( list->clazz.node_done )
        list->clazz.node_done( node, list->data );

      FT_FREE( node );
    }
  }

Referenced by FTC_MruList_RemoveSelection(), and FTC_MruList_Reset().

FTC_MruList_RemoveSelection()

FTC_MruList_RemoveSelection	(	FTC_MruList	list,
		FTC_MruNode_CompareFunc	selection,
		FT_Pointer	key
	)

Definition at line 327 of file ftcmru.c.

  {
    FTC_MruNode  first, node, next;


    first = list->nodes;
    while ( first && ( !selection || selection( first, key ) ) )
    {
      FTC_MruList_Remove( list, first );
      first = list->nodes;
    }

    if ( first )
    {
      node = first->next;
      while ( node != first )
      {
        next = node->next;

        if ( selection( node, key ) )
          FTC_MruList_Remove( list, node );

        node = next;
      }
    }
  }

Referenced by ftc_face_node_done(), and FTC_Manager_RemoveFaceID().

FTC_MruList_Reset()

FTC_MruList_Reset

(

FTC_MruList

list

)

Definition at line 185 of file ftcmru.c.

  {
    while ( list->nodes )
      FTC_MruList_Remove( list, list->nodes );

    FT_ASSERT( list->num_nodes == 0 );
  }

Referenced by FTC_Manager_Reset(), and FTC_MruList_Done().

FTC_MruNode_Prepend()

FTC_MruNode_Prepend	(	FTC_MruNode *	plist,
		FTC_MruNode	node
	)

Definition at line 29 of file ftcmru.c.

  {
    FTC_MruNode  first = *plist;


    if ( first )
    {
      FTC_MruNode  last = first->prev;


#ifdef FT_DEBUG_ERROR
      {
        FTC_MruNode  cnode = first;


        do
        {
          if ( cnode == node )
          {
            fprintf( stderr, "FTC_MruNode_Prepend: invalid action\n" );
            exit( 2 );
          }
          cnode = cnode->next;

        } while ( cnode != first );
      }
#endif

      first->prev = node;
      last->next  = node;
      node->next  = first;
      node->prev  = last;
    }
    else
    {
      node->next = node;
      node->prev = node;
    }
    *plist = node;
  }

Referenced by FTC_MruList_New(), and ftc_node_mru_link().

FTC_MruNode_Remove()

FTC_MruNode_Remove	(	FTC_MruNode *	plist,
		FTC_MruNode	node
	)

Definition at line 122 of file ftcmru.c.

  {
    FTC_MruNode  first = *plist;
    FTC_MruNode  prev, next;


    FT_ASSERT( first );

#ifdef FT_DEBUG_ERROR
      {
        FTC_MruNode  cnode = first;


        do
        {
          if ( cnode == node )
            goto Ok;
          cnode = cnode->next;

        } while ( cnode != first );

        fprintf( stderr, "FTC_MruNode_Remove: invalid action\n" );
        exit( 2 );
      Ok:
      }
#endif

    prev = node->prev;
    next = node->next;

    prev->next = next;
    next->prev = prev;

    if ( node == next )
    {
      FT_ASSERT( first == node );
      FT_ASSERT( prev  == node );

      *plist = NULL;
    }
    else if ( node == first )
      *plist = next;
  }

Referenced by FTC_MruList_New(), FTC_MruList_Remove(), and ftc_node_mru_unlink().

FTC_MruNode_Up()

FTC_MruNode_Up	(	FTC_MruNode *	plist,
		FTC_MruNode	node
	)

Definition at line 73 of file ftcmru.c.

  {
    FTC_MruNode  first = *plist;


    FT_ASSERT( first );

    if ( first != node )
    {
      FTC_MruNode  prev, next, last;


#ifdef FT_DEBUG_ERROR
      {
        FTC_MruNode  cnode = first;
        do
        {
          if ( cnode == node )
            goto Ok;
          cnode = cnode->next;

        } while ( cnode != first );

        fprintf( stderr, "FTC_MruNode_Up: invalid action\n" );
        exit( 2 );
      Ok:
      }
#endif
      prev = node->prev;
      next = node->next;

      prev->next = next;
      next->prev = prev;

      last = first->prev;

      last->next  = node;
      first->prev = node;

      node->next = first;
      node->prev = last;

      *plist = node;
    }
  }

Referenced by FTC_MruList_New().