glib/gcache.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_CACHE_H__
  32 #define __G_CACHE_H__
  33
  34 #include <glib/glist.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GCache          GCache;
  39
  40 typedef gpointer        (*GCacheNewFunc)        (gpointer       key);
  41 typedef gpointer        (*GCacheDupFunc)        (gpointer       value);
  42 typedef void            (*GCacheDestroyFunc)    (gpointer       value);
  43
  44 /* Caches
  45  */
  46 GCache*  g_cache_new           (GCacheNewFunc      value_new_func,
  47                                 GCacheDestroyFunc  value_destroy_func,
  48                                 GCacheDupFunc      key_dup_func,
  49                                 GCacheDestroyFunc  key_destroy_func,
  50                                 GHashFunc          hash_key_func,
  51                                 GHashFunc          hash_value_func,
  52                                 GEqualFunc         key_equal_func);
  53 void     g_cache_destroy       (GCache            *cache);
  54 gpointer g_cache_insert        (GCache            *cache,
  55                                 gpointer           key);
  56 void     g_cache_remove        (GCache            *cache,
  57                                 gconstpointer      value);
  58 void     g_cache_key_foreach   (GCache            *cache,
  59                                 GHFunc             func,
  60                                 gpointer           user_data);
  61 #ifndef G_DISABLE_DEPRECATED
  62 void     g_cache_value_foreach (GCache            *cache,
  63                                 GHFunc             func,
  64                                 gpointer           user_data);
  65 #endif
  66
  67 G_END_DECLS
  68
  69 #endif /* __G_CACHE_H__ */