ghash.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  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. * Modified by the GLib Team and others 1997-2000. See the AUTHORS
  21. * file for a list of people on the GLib Team. See the ChangeLog
  22. * files for a list of changes. These files are distributed with
  23. * GLib at ftp://ftp.gtk.org/pub/gtk/.
  24. */
  25. #ifndef __G_HASH_H__
  26. #define __G_HASH_H__
  27. #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28. #error "Only <glib.h> can be included directly."
  29. #endif
  30. #include <glib/gtypes.h>
  31. #include <glib/garray.h>
  32. #include <glib/glist.h>
  33. G_BEGIN_DECLS
  34. typedef struct _GHashTable GHashTable;
  35. typedef gboolean (*GHRFunc) (gpointer key,
  36. gpointer value,
  37. gpointer user_data);
  38. typedef struct _GHashTableIter GHashTableIter;
  39. struct _GHashTableIter
  40. {
  41. /*< private >*/
  42. gpointer dummy1;
  43. gpointer dummy2;
  44. gpointer dummy3;
  45. int dummy4;
  46. gboolean dummy5;
  47. gpointer dummy6;
  48. };
  49. GLIB_AVAILABLE_IN_ALL
  50. GHashTable* g_hash_table_new (GHashFunc hash_func,
  51. GEqualFunc key_equal_func);
  52. GLIB_AVAILABLE_IN_ALL
  53. GHashTable* g_hash_table_new_full (GHashFunc hash_func,
  54. GEqualFunc key_equal_func,
  55. GDestroyNotify key_destroy_func,
  56. GDestroyNotify value_destroy_func);
  57. GLIB_AVAILABLE_IN_2_72
  58. GHashTable *g_hash_table_new_similar (GHashTable *other_hash_table);
  59. GLIB_AVAILABLE_IN_ALL
  60. void g_hash_table_destroy (GHashTable *hash_table);
  61. GLIB_AVAILABLE_IN_ALL
  62. gboolean g_hash_table_insert (GHashTable *hash_table,
  63. gpointer key,
  64. gpointer value);
  65. GLIB_AVAILABLE_IN_ALL
  66. gboolean g_hash_table_replace (GHashTable *hash_table,
  67. gpointer key,
  68. gpointer value);
  69. GLIB_AVAILABLE_IN_ALL
  70. gboolean g_hash_table_add (GHashTable *hash_table,
  71. gpointer key);
  72. GLIB_AVAILABLE_IN_ALL
  73. gboolean g_hash_table_remove (GHashTable *hash_table,
  74. gconstpointer key);
  75. GLIB_AVAILABLE_IN_ALL
  76. void g_hash_table_remove_all (GHashTable *hash_table);
  77. GLIB_AVAILABLE_IN_ALL
  78. gboolean g_hash_table_steal (GHashTable *hash_table,
  79. gconstpointer key);
  80. GLIB_AVAILABLE_IN_2_58
  81. gboolean g_hash_table_steal_extended (GHashTable *hash_table,
  82. gconstpointer lookup_key,
  83. gpointer *stolen_key,
  84. gpointer *stolen_value);
  85. GLIB_AVAILABLE_IN_ALL
  86. void g_hash_table_steal_all (GHashTable *hash_table);
  87. GLIB_AVAILABLE_IN_2_76
  88. GPtrArray * g_hash_table_steal_all_keys (GHashTable *hash_table);
  89. GLIB_AVAILABLE_IN_2_76
  90. GPtrArray * g_hash_table_steal_all_values (GHashTable *hash_table);
  91. GLIB_AVAILABLE_IN_ALL
  92. gpointer g_hash_table_lookup (GHashTable *hash_table,
  93. gconstpointer key);
  94. GLIB_AVAILABLE_IN_ALL
  95. gboolean g_hash_table_contains (GHashTable *hash_table,
  96. gconstpointer key);
  97. GLIB_AVAILABLE_IN_ALL
  98. gboolean g_hash_table_lookup_extended (GHashTable *hash_table,
  99. gconstpointer lookup_key,
  100. gpointer *orig_key,
  101. gpointer *value);
  102. GLIB_AVAILABLE_IN_ALL
  103. void g_hash_table_foreach (GHashTable *hash_table,
  104. GHFunc func,
  105. gpointer user_data);
  106. GLIB_AVAILABLE_IN_ALL
  107. gpointer g_hash_table_find (GHashTable *hash_table,
  108. GHRFunc predicate,
  109. gpointer user_data);
  110. GLIB_AVAILABLE_IN_ALL
  111. guint g_hash_table_foreach_remove (GHashTable *hash_table,
  112. GHRFunc func,
  113. gpointer user_data);
  114. GLIB_AVAILABLE_IN_ALL
  115. guint g_hash_table_foreach_steal (GHashTable *hash_table,
  116. GHRFunc func,
  117. gpointer user_data);
  118. GLIB_AVAILABLE_IN_ALL
  119. guint g_hash_table_size (GHashTable *hash_table);
  120. GLIB_AVAILABLE_IN_ALL
  121. GList * g_hash_table_get_keys (GHashTable *hash_table);
  122. GLIB_AVAILABLE_IN_ALL
  123. GList * g_hash_table_get_values (GHashTable *hash_table);
  124. GLIB_AVAILABLE_IN_2_40
  125. gpointer * g_hash_table_get_keys_as_array (GHashTable *hash_table,
  126. guint *length);
  127. GLIB_AVAILABLE_IN_2_76
  128. GPtrArray * g_hash_table_get_keys_as_ptr_array (GHashTable *hash_table);
  129. GLIB_AVAILABLE_IN_2_76
  130. GPtrArray * g_hash_table_get_values_as_ptr_array (GHashTable *hash_table);
  131. GLIB_AVAILABLE_IN_ALL
  132. void g_hash_table_iter_init (GHashTableIter *iter,
  133. GHashTable *hash_table);
  134. GLIB_AVAILABLE_IN_ALL
  135. gboolean g_hash_table_iter_next (GHashTableIter *iter,
  136. gpointer *key,
  137. gpointer *value);
  138. GLIB_AVAILABLE_IN_ALL
  139. GHashTable* g_hash_table_iter_get_hash_table (GHashTableIter *iter);
  140. GLIB_AVAILABLE_IN_ALL
  141. void g_hash_table_iter_remove (GHashTableIter *iter);
  142. GLIB_AVAILABLE_IN_2_30
  143. void g_hash_table_iter_replace (GHashTableIter *iter,
  144. gpointer value);
  145. GLIB_AVAILABLE_IN_ALL
  146. void g_hash_table_iter_steal (GHashTableIter *iter);
  147. GLIB_AVAILABLE_IN_ALL
  148. GHashTable* g_hash_table_ref (GHashTable *hash_table);
  149. GLIB_AVAILABLE_IN_ALL
  150. void g_hash_table_unref (GHashTable *hash_table);
  151. #define g_hash_table_freeze(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
  152. #define g_hash_table_thaw(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
  153. /* Hash Functions
  154. */
  155. GLIB_AVAILABLE_IN_ALL
  156. gboolean g_str_equal (gconstpointer v1,
  157. gconstpointer v2);
  158. /* Macro for optimization in the case it is not used as callback function */
  159. #define g_str_equal(v1, v2) (strcmp ((const char *) (v1), (const char *) (v2)) == 0)
  160. GLIB_AVAILABLE_IN_ALL
  161. guint g_str_hash (gconstpointer v);
  162. GLIB_AVAILABLE_IN_ALL
  163. gboolean g_int_equal (gconstpointer v1,
  164. gconstpointer v2);
  165. GLIB_AVAILABLE_IN_ALL
  166. guint g_int_hash (gconstpointer v);
  167. GLIB_AVAILABLE_IN_ALL
  168. gboolean g_int64_equal (gconstpointer v1,
  169. gconstpointer v2);
  170. GLIB_AVAILABLE_IN_ALL
  171. guint g_int64_hash (gconstpointer v);
  172. GLIB_AVAILABLE_IN_ALL
  173. gboolean g_double_equal (gconstpointer v1,
  174. gconstpointer v2);
  175. GLIB_AVAILABLE_IN_ALL
  176. guint g_double_hash (gconstpointer v);
  177. GLIB_AVAILABLE_IN_ALL
  178. guint g_direct_hash (gconstpointer v) G_GNUC_CONST;
  179. GLIB_AVAILABLE_IN_ALL
  180. gboolean g_direct_equal (gconstpointer v1,
  181. gconstpointer v2) G_GNUC_CONST;
  182. G_END_DECLS
  183. #endif /* __G_HASH_H__ */