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/garray.h>
36#include <glib/glist.h>
37
38G_BEGIN_DECLS
39
40typedef struct _GHashTable GHashTable;
41
42typedef gboolean (*GHRFunc) (gpointer key,
43 gpointer value,
44 gpointer user_data);
45
46typedef struct _GHashTableIter GHashTableIter;
47
48struct _GHashTableIter
49{
50 /*< private >*/
51 gpointer dummy1;
52 gpointer dummy2;
53 gpointer dummy3;
54 int dummy4;
55 gboolean dummy5;
56 gpointer dummy6;
57};
58
59GLIB_AVAILABLE_IN_ALL
60GHashTable* g_hash_table_new (GHashFunc hash_func,
61 GEqualFunc key_equal_func);
62GLIB_AVAILABLE_IN_ALL
63GHashTable* g_hash_table_new_full (GHashFunc hash_func,
64 GEqualFunc key_equal_func,
65 GDestroyNotify key_destroy_func,
66 GDestroyNotify value_destroy_func);
67GLIB_AVAILABLE_IN_2_72
68GHashTable *g_hash_table_new_similar (GHashTable *other_hash_table);
69GLIB_AVAILABLE_IN_ALL
70void g_hash_table_destroy (GHashTable *hash_table);
71GLIB_AVAILABLE_IN_ALL
72gboolean g_hash_table_insert (GHashTable *hash_table,
73 gpointer key,
74 gpointer value);
75GLIB_AVAILABLE_IN_ALL
76gboolean g_hash_table_replace (GHashTable *hash_table,
77 gpointer key,
78 gpointer value);
79GLIB_AVAILABLE_IN_ALL
80gboolean g_hash_table_add (GHashTable *hash_table,
81 gpointer key);
82GLIB_AVAILABLE_IN_ALL
83gboolean g_hash_table_remove (GHashTable *hash_table,
84 gconstpointer key);
85GLIB_AVAILABLE_IN_ALL
86void g_hash_table_remove_all (GHashTable *hash_table);
87GLIB_AVAILABLE_IN_ALL
88gboolean g_hash_table_steal (GHashTable *hash_table,
89 gconstpointer key);
90GLIB_AVAILABLE_IN_2_58
91gboolean g_hash_table_steal_extended (GHashTable *hash_table,
92 gconstpointer lookup_key,
93 gpointer *stolen_key,
94 gpointer *stolen_value);
95GLIB_AVAILABLE_IN_ALL
96void g_hash_table_steal_all (GHashTable *hash_table);
97GLIB_AVAILABLE_IN_2_76
98GPtrArray * g_hash_table_steal_all_keys (GHashTable *hash_table);
99GLIB_AVAILABLE_IN_2_76
100GPtrArray * g_hash_table_steal_all_values (GHashTable *hash_table);
101GLIB_AVAILABLE_IN_ALL
102gpointer g_hash_table_lookup (GHashTable *hash_table,
103 gconstpointer key);
104GLIB_AVAILABLE_IN_ALL
105gboolean g_hash_table_contains (GHashTable *hash_table,
106 gconstpointer key);
107GLIB_AVAILABLE_IN_ALL
108gboolean g_hash_table_lookup_extended (GHashTable *hash_table,
109 gconstpointer lookup_key,
110 gpointer *orig_key,
111 gpointer *value);
112GLIB_AVAILABLE_IN_ALL
113void g_hash_table_foreach (GHashTable *hash_table,
114 GHFunc func,
115 gpointer user_data);
116GLIB_AVAILABLE_IN_ALL
117gpointer g_hash_table_find (GHashTable *hash_table,
118 GHRFunc predicate,
119 gpointer user_data);
120GLIB_AVAILABLE_IN_ALL
121guint g_hash_table_foreach_remove (GHashTable *hash_table,
122 GHRFunc func,
123 gpointer user_data);
124GLIB_AVAILABLE_IN_ALL
125guint g_hash_table_foreach_steal (GHashTable *hash_table,
126 GHRFunc func,
127 gpointer user_data);
128GLIB_AVAILABLE_IN_ALL
129guint g_hash_table_size (GHashTable *hash_table);
130GLIB_AVAILABLE_IN_ALL
131GList * g_hash_table_get_keys (GHashTable *hash_table);
132GLIB_AVAILABLE_IN_ALL
133GList * g_hash_table_get_values (GHashTable *hash_table);
134GLIB_AVAILABLE_IN_2_40
135gpointer * g_hash_table_get_keys_as_array (GHashTable *hash_table,
136 guint *length);
137GLIB_AVAILABLE_IN_2_76
138GPtrArray * g_hash_table_get_keys_as_ptr_array (GHashTable *hash_table);
139
140GLIB_AVAILABLE_IN_2_76
141GPtrArray * g_hash_table_get_values_as_ptr_array (GHashTable *hash_table);
142
143GLIB_AVAILABLE_IN_ALL
144void g_hash_table_iter_init (GHashTableIter *iter,
145 GHashTable *hash_table);
146GLIB_AVAILABLE_IN_ALL
147gboolean g_hash_table_iter_next (GHashTableIter *iter,
148 gpointer *key,
149 gpointer *value);
150GLIB_AVAILABLE_IN_ALL
151GHashTable* g_hash_table_iter_get_hash_table (GHashTableIter *iter);
152GLIB_AVAILABLE_IN_ALL
153void g_hash_table_iter_remove (GHashTableIter *iter);
154GLIB_AVAILABLE_IN_2_30
155void g_hash_table_iter_replace (GHashTableIter *iter,
156 gpointer value);
157GLIB_AVAILABLE_IN_ALL
158void g_hash_table_iter_steal (GHashTableIter *iter);
159
160GLIB_AVAILABLE_IN_ALL
161GHashTable* g_hash_table_ref (GHashTable *hash_table);
162GLIB_AVAILABLE_IN_ALL
163void g_hash_table_unref (GHashTable *hash_table);
164
165#define g_hash_table_freeze(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
166#define g_hash_table_thaw(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
167
168/* Hash Functions
169 */
170GLIB_AVAILABLE_IN_ALL
171gboolean g_str_equal (gconstpointer v1,
172 gconstpointer v2);
173
174/* Macro for optimization in the case it is not used as callback function */
175#define g_str_equal(v1, v2) (strcmp ((const char *) (v1), (const char *) (v2)) == 0)
176
177GLIB_AVAILABLE_IN_ALL
178guint g_str_hash (gconstpointer v);
179
180GLIB_AVAILABLE_IN_ALL
181gboolean g_int_equal (gconstpointer v1,
182 gconstpointer v2);
183GLIB_AVAILABLE_IN_ALL
184guint g_int_hash (gconstpointer v);
185
186GLIB_AVAILABLE_IN_ALL
187gboolean g_int64_equal (gconstpointer v1,
188 gconstpointer v2);
189GLIB_AVAILABLE_IN_ALL
190guint g_int64_hash (gconstpointer v);
191
192GLIB_AVAILABLE_IN_ALL
193gboolean g_double_equal (gconstpointer v1,
194 gconstpointer v2);
195GLIB_AVAILABLE_IN_ALL
196guint g_double_hash (gconstpointer v);
197
198GLIB_AVAILABLE_IN_ALL
199guint g_direct_hash (gconstpointer v) G_GNUC_CONST;
200GLIB_AVAILABLE_IN_ALL
201gboolean g_direct_equal (gconstpointer v1,
202 gconstpointer v2) G_GNUC_CONST;
203
204G_END_DECLS
205
206#endif /* __G_HASH_H__ */
207

source code of include/glib-2.0/glib/ghash.h