glib/ghash.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 __G_HASH_H__
  28 #define __G_HASH_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gtypes.h>
  35 #include <glib/glist.h>
  36
  37 G_BEGIN_DECLS
  38
  39 typedef struct _GHashTable  GHashTable;
  40
  41 typedef gboolean  (*GHRFunc)  (gpointer  key,
  42                                gpointer  value,
  43                                gpointer  user_data);
  44
  45 typedef struct _GHashTableIter GHashTableIter;
  46
  47 struct _GHashTableIter
  48 {
  49   /*< private >*/
  50   gpointer      dummy1;
  51   gpointer      dummy2;
  52   gpointer      dummy3;
  53   int           dummy4;
  54   gboolean      dummy5;
  55   gpointer      dummy6;
  56 };
  57
  58 GLIB_AVAILABLE_IN_ALL
  59 GHashTable* g_hash_table_new               (GHashFunc       hash_func,
  60                                             GEqualFunc      key_equal_func);
  61 GLIB_AVAILABLE_IN_ALL
  62 GHashTable* g_hash_table_new_full          (GHashFunc       hash_func,
  63                                             GEqualFunc      key_equal_func,
  64                                             GDestroyNotify  key_destroy_func,
  65                                             GDestroyNotify  value_destroy_func);
  66 GLIB_AVAILABLE_IN_ALL
  67 void        g_hash_table_destroy           (GHashTable     *hash_table);
  68 GLIB_AVAILABLE_IN_ALL
  69 void        g_hash_table_insert            (GHashTable     *hash_table,
  70                                             gpointer        key,
  71                                             gpointer        value);
  72 GLIB_AVAILABLE_IN_ALL
  73 void        g_hash_table_replace           (GHashTable     *hash_table,
  74                                             gpointer        key,
  75                                             gpointer        value);
  76 GLIB_AVAILABLE_IN_ALL
  77 void        g_hash_table_add               (GHashTable     *hash_table,
  78                                             gpointer        key);
  79 GLIB_AVAILABLE_IN_ALL
  80 gboolean    g_hash_table_remove            (GHashTable     *hash_table,
  81                                             gconstpointer   key);
  82 GLIB_AVAILABLE_IN_ALL
  83 void        g_hash_table_remove_all        (GHashTable     *hash_table);
  84 GLIB_AVAILABLE_IN_ALL
  85 gboolean    g_hash_table_steal             (GHashTable     *hash_table,
  86                                             gconstpointer   key);
  87 GLIB_AVAILABLE_IN_ALL
  88 void        g_hash_table_steal_all         (GHashTable     *hash_table);
  89 GLIB_AVAILABLE_IN_ALL
  90 gpointer    g_hash_table_lookup            (GHashTable     *hash_table,
  91                                             gconstpointer   key);
  92 GLIB_AVAILABLE_IN_ALL
  93 gboolean    g_hash_table_contains          (GHashTable     *hash_table,
  94                                             gconstpointer   key);
  95 GLIB_AVAILABLE_IN_ALL
  96 gboolean    g_hash_table_lookup_extended   (GHashTable     *hash_table,
  97                                             gconstpointer   lookup_key,
  98                                             gpointer       *orig_key,
  99                                             gpointer       *value);
 100 GLIB_AVAILABLE_IN_ALL
 101 void        g_hash_table_foreach           (GHashTable     *hash_table,
 102                                             GHFunc          func,
 103                                             gpointer        user_data);
 104 GLIB_AVAILABLE_IN_ALL
 105 gpointer    g_hash_table_find              (GHashTable     *hash_table,
 106                                             GHRFunc         predicate,
 107                                             gpointer        user_data);
 108 GLIB_AVAILABLE_IN_ALL
 109 guint       g_hash_table_foreach_remove    (GHashTable     *hash_table,
 110                                             GHRFunc         func,
 111                                             gpointer        user_data);
 112 GLIB_AVAILABLE_IN_ALL
 113 guint       g_hash_table_foreach_steal     (GHashTable     *hash_table,
 114                                             GHRFunc         func,
 115                                             gpointer        user_data);
 116 GLIB_AVAILABLE_IN_ALL
 117 guint       g_hash_table_size              (GHashTable     *hash_table);
 118 GLIB_AVAILABLE_IN_ALL
 119 GList *     g_hash_table_get_keys          (GHashTable     *hash_table);
 120 GLIB_AVAILABLE_IN_ALL
 121 GList *     g_hash_table_get_values        (GHashTable     *hash_table);
 122
 123 GLIB_AVAILABLE_IN_ALL
 124 void        g_hash_table_iter_init         (GHashTableIter *iter,
 125                                             GHashTable     *hash_table);
 126 GLIB_AVAILABLE_IN_ALL
 127 gboolean    g_hash_table_iter_next         (GHashTableIter *iter,
 128                                             gpointer       *key,
 129                                             gpointer       *value);
 130 GLIB_AVAILABLE_IN_ALL
 131 GHashTable* g_hash_table_iter_get_hash_table (GHashTableIter *iter);
 132 GLIB_AVAILABLE_IN_ALL
 133 void        g_hash_table_iter_remove       (GHashTableIter *iter);
 134 GLIB_AVAILABLE_IN_2_30
 135 void        g_hash_table_iter_replace      (GHashTableIter *iter,
 136                                             gpointer        value);
 137 GLIB_AVAILABLE_IN_ALL
 138 void        g_hash_table_iter_steal        (GHashTableIter *iter);
 139
 140 GLIB_AVAILABLE_IN_ALL
 141 GHashTable* g_hash_table_ref               (GHashTable     *hash_table);
 142 GLIB_AVAILABLE_IN_ALL
 143 void        g_hash_table_unref             (GHashTable     *hash_table);
 144
 145 #ifndef G_DISABLE_DEPRECATED
 146 #define g_hash_table_freeze(hash_table) ((void)0)
 147 #define g_hash_table_thaw(hash_table) ((void)0)
 148 #endif
 149
 150 /* Hash Functions
 151  */
 152 GLIB_AVAILABLE_IN_ALL
 153 gboolean g_str_equal    (gconstpointer  v1,
 154                          gconstpointer  v2);
 155 GLIB_AVAILABLE_IN_ALL
 156 guint    g_str_hash     (gconstpointer  v);
 157
 158 GLIB_AVAILABLE_IN_ALL
 159 gboolean g_int_equal    (gconstpointer  v1,
 160                          gconstpointer  v2);
 161 GLIB_AVAILABLE_IN_ALL
 162 guint    g_int_hash     (gconstpointer  v);
 163
 164 GLIB_AVAILABLE_IN_ALL
 165 gboolean g_int64_equal  (gconstpointer  v1,
 166                          gconstpointer  v2);
 167 GLIB_AVAILABLE_IN_ALL
 168 guint    g_int64_hash   (gconstpointer  v);
 169
 170 GLIB_AVAILABLE_IN_ALL
 171 gboolean g_double_equal (gconstpointer  v1,
 172                          gconstpointer  v2);
 173 GLIB_AVAILABLE_IN_ALL
 174 guint    g_double_hash  (gconstpointer  v);
 175
 176 GLIB_AVAILABLE_IN_ALL
 177 guint    g_direct_hash  (gconstpointer  v) G_GNUC_CONST;
 178 GLIB_AVAILABLE_IN_ALL
 179 gboolean g_direct_equal (gconstpointer  v1,
 180                          gconstpointer  v2) G_GNUC_CONST;
 181
 182 G_END_DECLS
 183
 184 #endif /* __G_HASH_H__ */