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  * SPDX-License-Identifier: LGPL-2.1-or-later
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  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_2_72
  67 GHashTable *g_hash_table_new_similar       (GHashTable     *other_hash_table);
  68 GLIB_AVAILABLE_IN_ALL
  69 void        g_hash_table_destroy           (GHashTable     *hash_table);
  70 GLIB_AVAILABLE_IN_ALL
  71 gboolean    g_hash_table_insert            (GHashTable     *hash_table,
  72                                             gpointer        key,
  73                                             gpointer        value);
  74 GLIB_AVAILABLE_IN_ALL
  75 gboolean    g_hash_table_replace           (GHashTable     *hash_table,
  76                                             gpointer        key,
  77                                             gpointer        value);
  78 GLIB_AVAILABLE_IN_ALL
  79 gboolean    g_hash_table_add               (GHashTable     *hash_table,
  80                                             gpointer        key);
  81 GLIB_AVAILABLE_IN_ALL
  82 gboolean    g_hash_table_remove            (GHashTable     *hash_table,
  83                                             gconstpointer   key);
  84 GLIB_AVAILABLE_IN_ALL
  85 void        g_hash_table_remove_all        (GHashTable     *hash_table);
  86 GLIB_AVAILABLE_IN_ALL
  87 gboolean    g_hash_table_steal             (GHashTable     *hash_table,
  88                                             gconstpointer   key);
  89 GLIB_AVAILABLE_IN_2_58
  90 gboolean    g_hash_table_steal_extended    (GHashTable     *hash_table,
  91                                             gconstpointer   lookup_key,
  92                                             gpointer       *stolen_key,
  93                                             gpointer       *stolen_value);
  94 GLIB_AVAILABLE_IN_ALL
  95 void        g_hash_table_steal_all         (GHashTable     *hash_table);
  96 GLIB_AVAILABLE_IN_ALL
  97 gpointer    g_hash_table_lookup            (GHashTable     *hash_table,
  98                                             gconstpointer   key);
  99 GLIB_AVAILABLE_IN_ALL
 100 gboolean    g_hash_table_contains          (GHashTable     *hash_table,
 101                                             gconstpointer   key);
 102 GLIB_AVAILABLE_IN_ALL
 103 gboolean    g_hash_table_lookup_extended   (GHashTable     *hash_table,
 104                                             gconstpointer   lookup_key,
 105                                             gpointer       *orig_key,
 106                                             gpointer       *value);
 107 GLIB_AVAILABLE_IN_ALL
 108 void        g_hash_table_foreach           (GHashTable     *hash_table,
 109                                             GHFunc          func,
 110                                             gpointer        user_data);
 111 GLIB_AVAILABLE_IN_ALL
 112 gpointer    g_hash_table_find              (GHashTable     *hash_table,
 113                                             GHRFunc         predicate,
 114                                             gpointer        user_data);
 115 GLIB_AVAILABLE_IN_ALL
 116 guint       g_hash_table_foreach_remove    (GHashTable     *hash_table,
 117                                             GHRFunc         func,
 118                                             gpointer        user_data);
 119 GLIB_AVAILABLE_IN_ALL
 120 guint       g_hash_table_foreach_steal     (GHashTable     *hash_table,
 121                                             GHRFunc         func,
 122                                             gpointer        user_data);
 123 GLIB_AVAILABLE_IN_ALL
 124 guint       g_hash_table_size              (GHashTable     *hash_table);
 125 GLIB_AVAILABLE_IN_ALL
 126 GList *     g_hash_table_get_keys          (GHashTable     *hash_table);
 127 GLIB_AVAILABLE_IN_ALL
 128 GList *     g_hash_table_get_values        (GHashTable     *hash_table);
 129 GLIB_AVAILABLE_IN_2_40
 130 gpointer *  g_hash_table_get_keys_as_array (GHashTable     *hash_table,
 131                                             guint          *length);
 132
 133 GLIB_AVAILABLE_IN_ALL
 134 void        g_hash_table_iter_init         (GHashTableIter *iter,
 135                                             GHashTable     *hash_table);
 136 GLIB_AVAILABLE_IN_ALL
 137 gboolean    g_hash_table_iter_next         (GHashTableIter *iter,
 138                                             gpointer       *key,
 139                                             gpointer       *value);
 140 GLIB_AVAILABLE_IN_ALL
 141 GHashTable* g_hash_table_iter_get_hash_table (GHashTableIter *iter);
 142 GLIB_AVAILABLE_IN_ALL
 143 void        g_hash_table_iter_remove       (GHashTableIter *iter);
 144 GLIB_AVAILABLE_IN_2_30
 145 void        g_hash_table_iter_replace      (GHashTableIter *iter,
 146                                             gpointer        value);
 147 GLIB_AVAILABLE_IN_ALL
 148 void        g_hash_table_iter_steal        (GHashTableIter *iter);
 149
 150 GLIB_AVAILABLE_IN_ALL
 151 GHashTable* g_hash_table_ref               (GHashTable     *hash_table);
 152 GLIB_AVAILABLE_IN_ALL
 153 void        g_hash_table_unref             (GHashTable     *hash_table);
 154
 155 #define g_hash_table_freeze(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
 156 #define g_hash_table_thaw(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
 157
 158 /* Hash Functions
 159  */
 160 GLIB_AVAILABLE_IN_ALL
 161 gboolean g_str_equal    (gconstpointer  v1,
 162                          gconstpointer  v2);
 163
 164 /* Macro for optimization in the case it is not used as callback function */
 165 #define g_str_equal(v1, v2) (strcmp ((const char *) (v1), (const char *) (v2)) == 0)
 166
 167 GLIB_AVAILABLE_IN_ALL
 168 guint    g_str_hash     (gconstpointer  v);
 169
 170 GLIB_AVAILABLE_IN_ALL
 171 gboolean g_int_equal    (gconstpointer  v1,
 172                          gconstpointer  v2);
 173 GLIB_AVAILABLE_IN_ALL
 174 guint    g_int_hash     (gconstpointer  v);
 175
 176 GLIB_AVAILABLE_IN_ALL
 177 gboolean g_int64_equal  (gconstpointer  v1,
 178                          gconstpointer  v2);
 179 GLIB_AVAILABLE_IN_ALL
 180 guint    g_int64_hash   (gconstpointer  v);
 181
 182 GLIB_AVAILABLE_IN_ALL
 183 gboolean g_double_equal (gconstpointer  v1,
 184                          gconstpointer  v2);
 185 GLIB_AVAILABLE_IN_ALL
 186 guint    g_double_hash  (gconstpointer  v);
 187
 188 GLIB_AVAILABLE_IN_ALL
 189 guint    g_direct_hash  (gconstpointer  v) G_GNUC_CONST;
 190 GLIB_AVAILABLE_IN_ALL
 191 gboolean g_direct_equal (gconstpointer  v1,
 192                          gconstpointer  v2) G_GNUC_CONST;
 193
 194 G_END_DECLS
 195
 196 #endif /* __G_HASH_H__ */