mono/utils/mono-hash.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 #ifndef __MONO_G_HASH_H__
  28 #define __MONO_G_HASH_H__
  29
  30 /*
  31  * Imported in mono cvs from version 1.7 of gnome cvs.
  32  * This hash table is GC friendly and the pointers stored in it
  33  * are tracked by the garbage collector.
  34  */
  35
  36 #include <glib.h>
  37
  38 G_BEGIN_DECLS
  39
  40 typedef struct _MonoGHashTable  MonoGHashTable;
  41
  42 typedef gpointer (*MonoGRemapperFunc) (gpointer key, gpointer value,
  43                                                                            gpointer user_data);
  44
  45 /* do not change the values of this enum */
  46 typedef enum {
  47         MONO_HASH_CONSERVATIVE_GC,
  48         MONO_HASH_KEY_GC,
  49         MONO_HASH_VALUE_GC,
  50         MONO_HASH_KEY_VALUE_GC /* note this is the OR of the other two values */
  51 } MonoGHashGCType;
  52
  53 /* Hash tables
  54  */
  55 MonoGHashTable* mono_g_hash_table_new              (GHashFunc       hash_func,
  56                                             GEqualFunc      key_equal_func);
  57 MonoGHashTable* mono_g_hash_table_new_type                 (GHashFunc       hash_func,
  58                                             GEqualFunc      key_equal_func,
  59                                             MonoGHashGCType type);
  60 MonoGHashTable* mono_g_hash_table_new_full                 (GHashFunc       hash_func,
  61                                             GEqualFunc      key_equal_func,
  62                                             GDestroyNotify  key_destroy_func,
  63                                             GDestroyNotify  value_destroy_func);
  64 void        mono_g_hash_table_destroy      (MonoGHashTable         *hash_table);
  65 void        mono_g_hash_table_insert               (MonoGHashTable         *hash_table,
  66                                             gpointer        key,
  67                                             gpointer        value);
  68 void        mono_g_hash_table_replace           (MonoGHashTable     *hash_table,
  69                                             gpointer        key,
  70                                             gpointer        value);
  71 gboolean    mono_g_hash_table_remove               (MonoGHashTable         *hash_table,
  72                                             gconstpointer   key);
  73 gboolean    mono_g_hash_table_steal             (MonoGHashTable     *hash_table,
  74                                             gconstpointer   key);
  75 gpointer    mono_g_hash_table_lookup               (MonoGHashTable         *hash_table,
  76                                             gconstpointer   key);
  77 gboolean    mono_g_hash_table_lookup_extended   (MonoGHashTable    *hash_table,
  78                                             gconstpointer   lookup_key,
  79                                             gpointer       *orig_key,
  80                                             gpointer       *value);
  81 void        mono_g_hash_table_foreach      (MonoGHashTable         *hash_table,
  82                                             GHFunc          func,
  83                                             gpointer        user_data);
  84 guint       mono_g_hash_table_foreach_remove       (MonoGHashTable         *hash_table,
  85                                             GHRFunc         func,
  86                                             gpointer        user_data);
  87 guint       mono_g_hash_table_foreach_steal        (MonoGHashTable         *hash_table,
  88                                             GHRFunc         func,
  89                                             gpointer        user_data);
  90 gpointer    mono_g_hash_table_find (MonoGHashTable *hash_table,
  91                                                                         GHRFunc predicate,
  92                                                                         gpointer user_data);
  93 guint       mono_g_hash_table_size                 (MonoGHashTable         *hash_table);
  94
  95 void        mono_g_hash_table_remap (MonoGHashTable *hash_table,
  96                                                                          MonoGRemapperFunc func,
  97                                                                          gpointer user_data);
  98
  99 G_END_DECLS
 100
 101 #endif /* __MONO_G_HASH_H__ */
 102