2000-09-16 00:42:06 +02:00
|
|
|
/***************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* ftcmanag.h */
|
|
|
|
/* */
|
|
|
|
/* FreeType Cache Manager (specification). */
|
|
|
|
/* */
|
2001-06-28 19:49:10 +02:00
|
|
|
/* Copyright 2000-2001 by */
|
2000-09-16 00:42:06 +02:00
|
|
|
/* 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. */
|
|
|
|
/* */
|
|
|
|
/***************************************************************************/
|
|
|
|
|
2000-10-12 07:05:40 +02:00
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* A cache manager is in charge of the following: */
|
|
|
|
/* */
|
|
|
|
/* - 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 */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* & FT_Size objects in order to speed up things considerably. */
|
2000-10-12 07:05:40 +02:00
|
|
|
/* */
|
|
|
|
/* - Manage one or more cache objects. Each cache is in charge of */
|
|
|
|
/* holding a varying number of `cache nodes'. Each cache node */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* represents a minimal amount of individually accessible cached */
|
2000-10-12 07:05:40 +02:00
|
|
|
/* data. For example, a cache node can be an FT_Glyph image */
|
|
|
|
/* containing a vector outline, or some glyph metrics, or anything */
|
|
|
|
/* else. */
|
|
|
|
/* */
|
|
|
|
/* Each cache node has a certain size in bytes that is added to the */
|
|
|
|
/* total amount of `cache memory' within the manager. */
|
|
|
|
/* */
|
|
|
|
/* All cache nodes are located in a global LRU list, where the oldest */
|
|
|
|
/* node is at the tail of the list. */
|
|
|
|
/* */
|
|
|
|
/* Each node belongs to a single cache, and includes a reference */
|
|
|
|
/* count to avoid destroying it (due to caching). */
|
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/********* *********/
|
2000-11-08 01:24:58 +01:00
|
|
|
/********* WARNING, THIS IS BETA CODE. *********/
|
2000-10-12 07:05:40 +02:00
|
|
|
/********* *********/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
|
|
|
/*************************************************************************/
|
2000-09-19 03:10:25 +02:00
|
|
|
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
#ifndef __FTCMANAG_H__
|
|
|
|
#define __FTCMANAG_H__
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2000-12-09 01:45:38 +01:00
|
|
|
|
|
|
|
#include <ft2build.h>
|
|
|
|
#include FT_CACHE_H
|
|
|
|
#include FT_CACHE_INTERNAL_LRU_H
|
2001-12-05 16:59:33 +01:00
|
|
|
#include FT_CACHE_INTERNAL_CACHE_H
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
FT_BEGIN_HEADER
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2001-01-11 10:27:49 +01:00
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* <Section> */
|
|
|
|
/* cache_subsystem */
|
|
|
|
/* */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
2000-12-09 01:45:38 +01:00
|
|
|
|
2000-10-28 09:26:59 +02:00
|
|
|
#define FTC_MAX_FACES_DEFAULT 2
|
|
|
|
#define FTC_MAX_SIZES_DEFAULT 4
|
2001-12-05 16:59:33 +01:00
|
|
|
#define FTC_MAX_BYTES_DEFAULT 200000L /* ~200 KB bytes by default */
|
2000-10-12 07:05:40 +02:00
|
|
|
|
|
|
|
/* maximum number of caches registered in a single manager */
|
|
|
|
#define FTC_MAX_CACHES 16
|
2000-09-16 00:42:06 +02:00
|
|
|
|
|
|
|
|
2001-12-05 16:59:33 +01:00
|
|
|
typedef struct FTC_FamilyEntryRec_
|
|
|
|
{
|
|
|
|
FTC_Family family;
|
|
|
|
FTC_Cache cache;
|
|
|
|
FT_UInt index;
|
|
|
|
FT_UInt link;
|
|
|
|
|
|
|
|
} FTC_FamilyEntryRec, *FTC_FamilyEntry;
|
|
|
|
|
|
|
|
#define FTC_FAMILY_ENTRY_NONE ((FT_UInt)-1)
|
|
|
|
|
|
|
|
typedef struct FTC_FamilyTableRec_
|
|
|
|
{
|
|
|
|
FT_UInt count;
|
|
|
|
FT_UInt size;
|
|
|
|
FTC_FamilyEntry entries;
|
|
|
|
FT_UInt free;
|
|
|
|
|
|
|
|
} FTC_FamilyTableRec, *FTC_FamilyTable;
|
2001-10-26 18:58:27 +02:00
|
|
|
|
2001-10-29 11:45:57 +01:00
|
|
|
|
2001-12-05 16:59:33 +01:00
|
|
|
FT_LOCAL FT_Error
|
|
|
|
ftc_family_table_alloc( FTC_FamilyTable table,
|
|
|
|
FT_Memory memory,
|
|
|
|
FTC_FamilyEntry *aentry );
|
2001-10-26 18:58:27 +02:00
|
|
|
|
|
|
|
|
2001-12-05 16:59:33 +01:00
|
|
|
FT_LOCAL void
|
|
|
|
ftc_family_table_free( FTC_FamilyTable table,
|
|
|
|
FT_UInt index );
|
|
|
|
|
2001-10-26 18:58:27 +02:00
|
|
|
|
2000-10-31 20:42:53 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* <Struct> */
|
|
|
|
/* FTC_ManagerRec */
|
|
|
|
/* */
|
|
|
|
/* <Description> */
|
|
|
|
/* The cache manager structure. */
|
|
|
|
/* */
|
|
|
|
/* <Fields> */
|
|
|
|
/* library :: A handle to a FreeType library instance. */
|
|
|
|
/* */
|
2001-10-29 11:45:57 +01:00
|
|
|
/* faces_list :: The lru list of FT_Face objects in the cache. */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* */
|
2001-10-29 11:45:57 +01:00
|
|
|
/* sizes_list :: The lru list of FT_Size objects in the cache. */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* */
|
2001-12-05 02:22:05 +01:00
|
|
|
/* max_weight :: The maximum cache pool weight. */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* */
|
2001-10-29 11:45:57 +01:00
|
|
|
/* cur_weight :: The current cache pool weight. */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* */
|
|
|
|
/* num_nodes :: The current number of nodes in the manager. */
|
|
|
|
/* */
|
2001-10-29 11:45:57 +01:00
|
|
|
/* nodes_list :: The global lru list of all cache nodes. */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/* */
|
2000-09-19 03:10:25 +02:00
|
|
|
typedef struct FTC_ManagerRec_
|
|
|
|
{
|
|
|
|
FT_Library library;
|
2001-10-26 18:58:27 +02:00
|
|
|
FT_LruList faces_list;
|
|
|
|
FT_LruList sizes_list;
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2001-10-26 18:58:27 +02:00
|
|
|
FT_ULong max_weight;
|
|
|
|
FT_ULong cur_weight;
|
|
|
|
|
2000-10-29 01:34:45 +02:00
|
|
|
FT_UInt num_nodes;
|
2001-10-26 18:58:27 +02:00
|
|
|
FTC_Node nodes_list;
|
|
|
|
|
2000-10-12 07:05:40 +02:00
|
|
|
FTC_Cache caches[FTC_MAX_CACHES];
|
|
|
|
|
2000-09-19 03:10:25 +02:00
|
|
|
FT_Pointer request_data;
|
|
|
|
FTC_Face_Requester request_face;
|
2000-10-12 07:05:40 +02:00
|
|
|
|
2001-12-05 16:59:33 +01:00
|
|
|
FTC_FamilyTableRec families;
|
|
|
|
|
2000-09-19 03:10:25 +02:00
|
|
|
} FTC_ManagerRec;
|
2000-09-16 00:42:06 +02:00
|
|
|
|
|
|
|
|
2000-10-31 20:42:53 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* */
|
|
|
|
/* <Function> */
|
|
|
|
/* FTC_Manager_Compress */
|
|
|
|
/* */
|
|
|
|
/* <Description> */
|
|
|
|
/* 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). */
|
|
|
|
/* */
|
2000-11-10 23:43:37 +01:00
|
|
|
/* <InOut> */
|
2000-10-31 20:42:53 +01:00
|
|
|
/* manager :: A handle to the cache manager. */
|
|
|
|
/* */
|
|
|
|
/* <Note> */
|
|
|
|
/* 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. */
|
|
|
|
/* */
|
2001-06-28 19:49:10 +02:00
|
|
|
FT_EXPORT( void )
|
|
|
|
FTC_Manager_Compress( FTC_Manager manager );
|
2000-10-29 01:34:45 +02:00
|
|
|
|
|
|
|
|
2001-10-26 18:58:27 +02:00
|
|
|
/* this must be used internally for the moment */
|
|
|
|
FT_EXPORT( FT_Error )
|
|
|
|
FTC_Manager_Register_Cache( FTC_Manager manager,
|
|
|
|
FTC_Cache_Class clazz,
|
|
|
|
FTC_Cache *acache );
|
2000-10-31 20:42:53 +01:00
|
|
|
|
|
|
|
|
2001-12-05 16:59:33 +01:00
|
|
|
/* can be called to increment a node's reference count */
|
|
|
|
FT_EXPORT(void)
|
|
|
|
FTC_Node_Ref( FTC_Node node,
|
|
|
|
FTC_Manager manager );
|
2000-09-19 03:10:25 +02:00
|
|
|
|
2000-10-12 07:05:40 +02:00
|
|
|
|
2001-12-05 16:59:33 +01:00
|
|
|
/* can be called to decrement a node's reference count */
|
|
|
|
FT_EXPORT(void)
|
|
|
|
FTC_Node_Unref( FTC_Node node,
|
|
|
|
FTC_Manager manager );
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2001-10-26 18:58:27 +02:00
|
|
|
/* */
|
2000-12-09 01:45:38 +01:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
FT_END_HEADER
|
2000-09-16 00:42:06 +02:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
#endif /* __FTCMANAG_H__ */
|
2000-09-16 00:42:06 +02:00
|
|
|
|
|
|
|
|
|
|
|
/* END */
|