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