From dd33561ecb0cb0cf7459e49d11d53a55199f3891 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Tue, 31 Oct 2000 19:42:53 +0000 Subject: [PATCH] Formatting. Adding a .cvsignore file. --- .cvsignore | 1 + include/freetype/cache/ftcmanag.h | 332 ++++++++++++++++-------------- include/freetype/cache/ftcsbits.h | 35 ++-- 3 files changed, 194 insertions(+), 174 deletions(-) create mode 100644 .cvsignore diff --git a/.cvsignore b/.cvsignore new file mode 100644 index 000000000..aee2e4ce1 --- /dev/null +++ b/.cvsignore @@ -0,0 +1 @@ +config.mk diff --git a/include/freetype/cache/ftcmanag.h b/include/freetype/cache/ftcmanag.h index ec899b9c4..32024d8e5 100644 --- a/include/freetype/cache/ftcmanag.h +++ b/include/freetype/cache/ftcmanag.h @@ -23,11 +23,11 @@ /* - Maintain a mapping between generic FTC_FaceIDs and live FT_Face */ /* objects. The mapping itself is performed through a user-provided */ /* callback. However, the manager maintains a small cache of FT_Face */ - /* & FT_Size objects in order to speed things considerably. */ + /* & FT_Size objects in order to speed up things considerably. */ /* */ /* - Manage one or more cache objects. Each cache is in charge of */ /* holding a varying number of `cache nodes'. Each cache node */ - /* represents a minimal amount of individually-accessible cached */ + /* represents a minimal amount of individually accessible cached */ /* data. For example, a cache node can be an FT_Glyph image */ /* containing a vector outline, or some glyph metrics, or anything */ /* else. */ @@ -81,40 +81,41 @@ #define FTC_MAX_CACHES 16 - /**************************************************************** - * - * FTC_ManagerRec - * - * - * the cache manager structure. Each cache manager is in - * charge of performing two tasks: - * - * - * library :: handle to FreeType library instance - * faces_lru :: lru list of FT_Face objects in cache - * sizes_lru :: lru list of FT_Size objects in cache - * - * max_bytes :: maximum number of bytes to be allocated - * in the cache. this is only related to - * the byte size of the nodes cached by - * the manager. - * - * num_bytes :: current number of bytes allocated in - * the cache. only related to the byte size - * of cached nodes. - * - * num_nodes :: current number of nodes in the manager - * - * global_lru :: the global lru list of all cache nodes - * - * caches :: a table of installed/registered cache - * objects - * - * request_data :: user-provided data passed to the requester - * request_face :: user-provided function used to implement - * a mapping between abstract FTC_FaceIDs - * and real FT_Face objects.. - */ + /*************************************************************************/ + /* */ + /* */ + /* FTC_ManagerRec */ + /* */ + /* */ + /* The cache manager structure. */ + /* */ + /* */ + /* library :: A handle to a FreeType library instance. */ + /* */ + /* faces_lru :: The lru list of FT_Face objects in the cache. */ + /* */ + /* sizes_lru :: The lru list of FT_Size objects in the cache. */ + /* */ + /* max_bytes :: The maximum number of bytes to be allocated in the */ + /* cache. This is only related to the byte size of */ + /* the nodes cached by the manager. */ + /* */ + /* num_bytes :: The current number of bytes allocated in the */ + /* cache. Only related to the byte size of cached */ + /* nodes. */ + /* */ + /* num_nodes :: The current number of nodes in the manager. */ + /* */ + /* global_lru :: The global lru list of all cache nodes. */ + /* */ + /* caches :: A table of installed/registered cache objects. */ + /* */ + /* request_data :: User-provided data passed to the requester. */ + /* */ + /* request_face :: User-provided function used to implement a mapping */ + /* between abstract FTC_FaceIDs and real FT_Face */ + /* objects. */ + /* */ typedef struct FTC_ManagerRec_ { FT_Library library; @@ -133,28 +134,27 @@ } FTC_ManagerRec; - /********************************************************************** - * - * FTC_Manager_Compress - * - * - * this function is used to check the state of the cache manager - * if its "num_bytes" field is greater than its "max_bytes" - * field, this function will flush as many old cache nodes as - * possible (ignoring cache nodes with a non-zero reference - * count). - * - * - * manager :: handle to cache manager - * - * - * client applications should not call this function directly. - * it is normally invoked by specific cache implementations. - * - * the reason this function is exported is to allow client- - * specific cache classes.. - * - */ + /*************************************************************************/ + /* */ + /* */ + /* FTC_Manager_Compress */ + /* */ + /* */ + /* This function is used to check the state of the cache manager if */ + /* its `num_bytes' field is greater than its `max_bytes' field. It */ + /* will flush as many old cache nodes as possible (ignoring cache */ + /* nodes with a non-zero reference count). */ + /* */ + /* */ + /* manager :: A handle to the cache manager. */ + /* */ + /* */ + /* Client applications should not call this function directly. It is */ + /* normally invoked by specific cache implementations. */ + /* */ + /* The reason this function is exported is to allow client-specific */ + /* cache classes. */ + /* */ FT_EXPORT_DEF( void ) FTC_Manager_Compress( FTC_Manager manager ); @@ -182,7 +182,7 @@ typedef FTC_CacheNodeRec* FTC_CacheNode; - /* the fields `cachenode.data' is typecasted to this type */ + /* the field `cachenode.data' is typecast to this type */ typedef struct FTC_CacheNode_Data_ { FT_UShort cache_index; @@ -190,63 +190,73 @@ } FTC_CacheNode_Data; - /* return a pointer to the FTC_CacheNode_Data contained in a */ - /* CacheNode's `data' field */ + + /* return a pointer to FTC_CacheNode_Data contained in a */ + /* CacheNode's `data' field */ #define FTC_CACHENODE_TO_DATA_P( n ) \ ( (FTC_CacheNode_Data*)&(n)->data ) #define FTC_LIST_TO_CACHENODE( n ) ( (FTC_CacheNode)(n) ) - /********************************************************************** - * - * FTC_CacheNode_SizeFunc - * - * - * a function used to compute the total size in bytes of a given - * cache node. It is used by the cache manager to compute the - * number of old nodes to flush when the cache is full.. - * - * - * node :: handle to target cache node - * cache_data :: a generic pointer passed to the destructor. - */ + + /*************************************************************************/ + /* */ + /* */ + /* FTC_CacheNode_SizeFunc */ + /* */ + /* */ + /* A function used to compute the total size in bytes of a given */ + /* cache node. It is used by the cache manager to compute the number */ + /* of old nodes to flush when the cache is full. */ + /* */ + /* */ + /* node :: A handle to the target cache node. */ + /* */ + /* cache_data :: A generic pointer passed to the destructor. */ + /* */ typedef FT_ULong (*FTC_CacheNode_SizeFunc)( FTC_CacheNode node, FT_Pointer cache_data ); - /********************************************************************** - * - * FTC_CacheNode_DestroyFunc - * - * - * a function used to destroy a given cache node. It is called - * by the manager when the cache is full and old nodes need to - * be flushed out.. - * - * - * node :: handle to target cache node - * cache_data :: a generic pointer passed to the destructor. - */ + + /*************************************************************************/ + /* */ + /* */ + /* FTC_CacheNode_DestroyFunc */ + /* */ + /* */ + /* A function used to destroy a given cache node. It is called by */ + /* the manager when the cache is full and old nodes need to be */ + /* flushed out. */ + /* */ + /* */ + /* node :: A handle to the target cache node. */ + /* */ + /* cache_data :: A generic pointer passed to the destructor. */ + /* */ typedef void (*FTC_CacheNode_DestroyFunc)( FTC_CacheNode node, FT_Pointer cache_data ); - /********************************************************************** - * - * FTC_CacheNode_Class - * - * - * a very simple structure used to describe a cache node's class - * to the cache manager - * - * - * size_node :: a function used to size the node - * destroy_node :: a function used to destroy the node - * - * - * the cache node class doesn't include a "new_node" function - * because the cache manager never allocates cache node directly, - * it delegates this task to its cache objects.. - * - */ + + /*************************************************************************/ + /* */ + /* */ + /* FTC_CacheNode_Class */ + /* */ + /* */ + /* A very simple structure used to describe a cache node's class to */ + /* the cache manager. */ + /* */ + /* */ + /* size_node :: A function used to size the node. */ + /* */ + /* destroy_node :: A function used to destroy the node. */ + /* */ + /* */ + /* The cache node class doesn't include a `new_node' function because */ + /* the cache manager never allocates cache node directly; it */ + /* delegates this task to its cache objects. */ + /* */ + /* */ typedef struct FTC_CacheNode_Class_ { FTC_CacheNode_SizeFunc size_node; @@ -264,45 +274,50 @@ /*************************************************************************/ - /********************************************************************** - * - * FTC_Cache_InitFunc - * - * - * a function used to initialize a given cache object - * - * - * cache :: handle to new cache - */ + /*************************************************************************/ + /* */ + /* */ + /* FTC_Cache_InitFunc */ + /* */ + /* */ + /* A function used to initialize a given cache object. */ + /* */ + /* */ + /* cache :: A handle to the new cache. */ + /* */ typedef FT_Error (*FTC_Cache_InitFunc)( FTC_Cache cache ); - /********************************************************************** - * - * FTC_Cache_DoneFunc - * - * - * a function used to finalize a given cache object - * - * - * cache :: handle to target cache - */ - typedef void (*FTC_Cache_DoneFunc)( FTC_Cache cache ); + /*************************************************************************/ + /* */ + /* */ + /* FTC_Cache_DoneFunc */ + /* */ + /* */ + /* A function to finalize a given cache object. */ + /* */ + /* */ + /* cache :: A handle to the target cache. */ + /* */ + typedef void (*FTC_Cache_DoneFunc)( FTC_Cache cache ); - /********************************************************************** - * - * FTC_Cache_Class - * - * - * a structure used to describe a given cache object class to - * the cache manager. - * - * - * cache_byte_size :: size of cache object in bytes - * init_cache :: cache object initializer - * done_cache :: cache object finalizer - */ + /*************************************************************************/ + /* */ + /* */ + /* FTC_Cache_Class */ + /* */ + /* */ + /* A structure used to describe a given cache object class to the */ + /* cache manager. */ + /* */ + /* */ + /* cache_byte_size :: The size of the cache object in bytes. */ + /* */ + /* init_cache :: The cache object initializer. */ + /* */ + /* done_cache :: The cache object finalizer. */ + /* */ struct FTC_Cache_Class_ { FT_UInt cache_byte_size; @@ -311,22 +326,28 @@ }; - /********************************************************************** - * - * FTC_CacheRec - * - * - * a structure used to describe an abstract cache object - * - * - * manager :: handle to parent cache manager - * memory :: handle to memory manager - * clazz :: pointer to cache clazz - * node_clazz :: pointer to cache's node clazz - * - * cache_index :: index of cache in manager's table - * cache_data :: data passed to the cache node constructor/finalizer - */ + /*************************************************************************/ + /* */ + /* */ + /* FTC_CacheRec */ + /* */ + /* */ + /* A structure used to describe an abstract cache object. */ + /* */ + /* */ + /* manager :: A handle to the parent cache manager. */ + /* */ + /* memory :: A handle to the memory manager. */ + /* */ + /* clazz :: A pointer to the cache class. */ + /* */ + /* node_clazz :: A pointer to the cache's node class. */ + /* */ + /* cache_index :: An index of the cache in the manager's table. */ + /* */ + /* cache_data :: Data passed to the cache node */ + /* constructor/finalizer. */ + /* */ typedef struct FTC_CacheRec_ { FTC_Manager manager; @@ -340,7 +361,6 @@ } FTC_CacheRec; - #ifdef __cplusplus } #endif diff --git a/include/freetype/cache/ftcsbits.h b/include/freetype/cache/ftcsbits.h index d9d801150..d95a81719 100644 --- a/include/freetype/cache/ftcsbits.h +++ b/include/freetype/cache/ftcsbits.h @@ -2,7 +2,7 @@ /* */ /* ftcsbits.h */ /* */ -/* a small-bitmaps cache (specification). */ +/* A small-bitmap cache (specification). */ /* */ /* Copyright 2000 by */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */ @@ -15,25 +15,27 @@ /* */ /***************************************************************************/ + #ifndef FTCSBITS_H #define FTCSBITS_H + #include + #ifdef __cplusplus extern "C" { #endif - /* handle to small bitmap */ - typedef struct FTC_SBitRec_* FTC_SBit; + /* handle to small bitmap */ + typedef struct FTC_SBitRec_* FTC_SBit; - /* handle to small bitmap cache */ - typedef struct FTC_SBit_CacheRec_* FTC_SBit_Cache; + /* handle to small bitmap cache */ + typedef struct FTC_SBit_CacheRec_* FTC_SBit_Cache; - - /* a compact structure used to hold a single small bitmap */ - typedef struct FTC_SBitRec_ + /* a compact structure used to hold a single small bitmap */ + typedef struct FTC_SBitRec_ { FT_Byte width; FT_Byte height; @@ -50,16 +52,13 @@ } FTC_SBitRec; - FT_EXPORT_DEF( FT_Error ) - FTC_SBit_Cache_New( FTC_Manager manager, - FTC_SBit_Cache *acache ); + FT_EXPORT_DEF( FT_Error ) FTC_SBit_Cache_New( FTC_Manager manager, + FTC_SBit_Cache* acache ); - - FT_EXPORT_DEF( FT_Error ) - FTC_SBit_Cache_Lookup( FTC_SBit_Cache cache, - FTC_Image_Desc* desc, - FT_UInt gindex, - FTC_SBit *sbit ); + FT_EXPORT_DEF( FT_Error ) FTC_SBit_Cache_Lookup( FTC_SBit_Cache cache, + FTC_Image_Desc* desc, + FT_UInt gindex, + FTC_SBit *sbit ); #ifdef __cplusplus @@ -69,5 +68,5 @@ #endif /* FTCSBITS_H */ -/* END */ +/* END */