home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / gd201.zip / gd-2.0.1 / gdcache.h < prev    next >
C/C++ Source or Header  |  2001-04-03  |  3KB  |  84 lines
  1. /* 
  2.  * gdcache.h
  3.  *
  4.  * Caches of pointers to user structs in which the least-recently-used 
  5.  * element is replaced in the event of a cache miss after the cache has 
  6.  * reached a given size.
  7.  *
  8.  * John Ellson  (ellson@lucent.com)  Oct 31, 1997
  9.  *
  10.  * Test this with:
  11.  *         gcc -o gdcache -g -Wall -DTEST gdcache.c
  12.  *
  13.  * The cache is implemented by a singly-linked list of elements
  14.  * each containing a pointer to a user struct that is being managed by
  15.  * the cache.
  16.  *
  17.  * The head structure has a pointer to the most-recently-used
  18.  * element, and elements are moved to this position in the list each
  19.  * time they are used.  The head also contains pointers to three
  20.  * user defined functions: 
  21.  *        - a function to test if a cached userdata matches some keydata 
  22.  *        - a function to provide a new userdata struct to the cache 
  23.  *          if there has been a cache miss.
  24.  *        - a function to release a userdata struct when it is
  25.  *          no longer being managed by the cache
  26.  *
  27.  * In the event of a cache miss the cache is allowed to grow up to
  28.  * a specified maximum size.  After the maximum size is reached then
  29.  * the least-recently-used element is discarded to make room for the 
  30.  * new.  The most-recently-returned value is always left at the 
  31.  * beginning of the list after retrieval.
  32.  *
  33.  * In the current implementation the cache is traversed by a linear
  34.  * search from most-recent to least-recent.  This linear search
  35.  * probably limits the usefulness of this implementation to cache
  36.  * sizes of a few tens of elements.
  37.  */
  38.  
  39. /*********************************************************/
  40. /* header                                                */
  41. /*********************************************************/
  42.  
  43. #include <malloc.h>
  44. #ifndef NULL
  45. #define NULL (void *)0
  46. #endif
  47.  
  48. /* user defined function templates */
  49. typedef int (*gdCacheTestFn_t)(void *userdata, void *keydata);
  50. typedef void *(*gdCacheFetchFn_t)(char **error, void *keydata);
  51. typedef void (*gdCacheReleaseFn_t)(void *userdata);
  52.  
  53. /* element structure */
  54. typedef struct gdCache_element_s gdCache_element_t;
  55. struct gdCache_element_s {
  56.     gdCache_element_t    *next;
  57.     void            *userdata;
  58. };
  59.  
  60. /* head structure */
  61. typedef struct gdCache_head_s gdCache_head_t;
  62. struct gdCache_head_s {
  63.     gdCache_element_t    *mru;
  64.     int                    size;
  65.     char                *error;
  66.     gdCacheTestFn_t        gdCacheTest;
  67.     gdCacheFetchFn_t    gdCacheFetch;
  68.     gdCacheReleaseFn_t    gdCacheRelease;
  69. };
  70.  
  71. /* function templates */
  72. gdCache_head_t *
  73. gdCacheCreate(
  74.     int                    size,
  75.     gdCacheTestFn_t        gdCacheTest,
  76.     gdCacheFetchFn_t    gdCacheFetch,
  77.     gdCacheReleaseFn_t    gdCacheRelease );
  78.  
  79. void
  80. gdCacheDelete( gdCache_head_t *head );
  81.  
  82. void *
  83. gdCacheGet( gdCache_head_t *head, void *keydata );
  84.