ghash.h 7.7 KB

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