[kdbus] sync with kdbus (kdbus.h - commit: 5ae1ecac44cb)
[platform/upstream/glib.git] / glib / ghash.h
index 9128721..d353088 100644 (file)
@@ -8,13 +8,11 @@
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
-#error "Only <glib.h> can be included directly."
-#endif
-
 #ifndef __G_HASH_H__
 #define __G_HASH_H__
 
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
 #include <glib/gtypes.h>
 #include <glib/glist.h>
 
@@ -47,117 +45,138 @@ typedef struct _GHashTableIter GHashTableIter;
 struct _GHashTableIter
 {
   /*< private >*/
-  gpointer     dummy1;
-  gpointer     dummy2;
-  gpointer     dummy3;
-  int          dummy4;
-  gboolean     dummy5;
-  gpointer     dummy6;
+  gpointer      dummy1;
+  gpointer      dummy2;
+  gpointer      dummy3;
+  int           dummy4;
+  gboolean      dummy5;
+  gpointer      dummy6;
 };
 
-/* Hash tables
- */
-GHashTable* g_hash_table_new              (GHashFunc       hash_func,
-                                           GEqualFunc      key_equal_func);
-GHashTable* g_hash_table_new_full                 (GHashFunc       hash_func,
-                                           GEqualFunc      key_equal_func,
-                                           GDestroyNotify  key_destroy_func,
-                                           GDestroyNotify  value_destroy_func);
-void       g_hash_table_destroy           (GHashTable     *hash_table);
-void       g_hash_table_insert            (GHashTable     *hash_table,
-                                           gpointer        key,
-                                           gpointer        value);
-void        g_hash_table_replace           (GHashTable     *hash_table,
-                                           gpointer        key,
-                                           gpointer        value);
-gboolean    g_hash_table_remove                   (GHashTable     *hash_table,
-                                           gconstpointer   key);
+GLIB_AVAILABLE_IN_ALL
+GHashTable* g_hash_table_new               (GHashFunc       hash_func,
+                                            GEqualFunc      key_equal_func);
+GLIB_AVAILABLE_IN_ALL
+GHashTable* g_hash_table_new_full          (GHashFunc       hash_func,
+                                            GEqualFunc      key_equal_func,
+                                            GDestroyNotify  key_destroy_func,
+                                            GDestroyNotify  value_destroy_func);
+GLIB_AVAILABLE_IN_ALL
+void        g_hash_table_destroy           (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
+gboolean    g_hash_table_insert            (GHashTable     *hash_table,
+                                            gpointer        key,
+                                            gpointer        value);
+GLIB_AVAILABLE_IN_ALL
+gboolean    g_hash_table_replace           (GHashTable     *hash_table,
+                                            gpointer        key,
+                                            gpointer        value);
+GLIB_AVAILABLE_IN_ALL
+gboolean    g_hash_table_add               (GHashTable     *hash_table,
+                                            gpointer        key);
+GLIB_AVAILABLE_IN_ALL
+gboolean    g_hash_table_remove            (GHashTable     *hash_table,
+                                            gconstpointer   key);
+GLIB_AVAILABLE_IN_ALL
 void        g_hash_table_remove_all        (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
 gboolean    g_hash_table_steal             (GHashTable     *hash_table,
-                                           gconstpointer   key);
+                                            gconstpointer   key);
+GLIB_AVAILABLE_IN_ALL
 void        g_hash_table_steal_all         (GHashTable     *hash_table);
-gpointer    g_hash_table_lookup                   (GHashTable     *hash_table,
-                                           gconstpointer   key);
-gboolean    g_hash_table_lookup_extended   (GHashTable    *hash_table,
-                                           gconstpointer   lookup_key,
-                                           gpointer       *orig_key,
-                                           gpointer       *value);
-void       g_hash_table_foreach           (GHashTable     *hash_table,
-                                           GHFunc          func,
-                                           gpointer        user_data);
-gpointer    g_hash_table_find             (GHashTable     *hash_table,
-                                           GHRFunc         predicate,
-                                           gpointer        user_data);
-guint      g_hash_table_foreach_remove    (GHashTable     *hash_table,
-                                           GHRFunc         func,
-                                           gpointer        user_data);
-guint      g_hash_table_foreach_steal     (GHashTable     *hash_table,
-                                           GHRFunc         func,
-                                           gpointer        user_data);
-guint      g_hash_table_size              (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
+gpointer    g_hash_table_lookup            (GHashTable     *hash_table,
+                                            gconstpointer   key);
+GLIB_AVAILABLE_IN_ALL
+gboolean    g_hash_table_contains          (GHashTable     *hash_table,
+                                            gconstpointer   key);
+GLIB_AVAILABLE_IN_ALL
+gboolean    g_hash_table_lookup_extended   (GHashTable     *hash_table,
+                                            gconstpointer   lookup_key,
+                                            gpointer       *orig_key,
+                                            gpointer       *value);
+GLIB_AVAILABLE_IN_ALL
+void        g_hash_table_foreach           (GHashTable     *hash_table,
+                                            GHFunc          func,
+                                            gpointer        user_data);
+GLIB_AVAILABLE_IN_ALL
+gpointer    g_hash_table_find              (GHashTable     *hash_table,
+                                            GHRFunc         predicate,
+                                            gpointer        user_data);
+GLIB_AVAILABLE_IN_ALL
+guint       g_hash_table_foreach_remove    (GHashTable     *hash_table,
+                                            GHRFunc         func,
+                                            gpointer        user_data);
+GLIB_AVAILABLE_IN_ALL
+guint       g_hash_table_foreach_steal     (GHashTable     *hash_table,
+                                            GHRFunc         func,
+                                            gpointer        user_data);
+GLIB_AVAILABLE_IN_ALL
+guint       g_hash_table_size              (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
 GList *     g_hash_table_get_keys          (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
 GList *     g_hash_table_get_values        (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_2_40
+gpointer *  g_hash_table_get_keys_as_array (GHashTable     *hash_table,
+                                            guint          *length);
 
+GLIB_AVAILABLE_IN_ALL
 void        g_hash_table_iter_init         (GHashTableIter *iter,
-                                           GHashTable     *hash_table);
+                                            GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
 gboolean    g_hash_table_iter_next         (GHashTableIter *iter,
-                                           gpointer       *key,
-                                           gpointer       *value);
+                                            gpointer       *key,
+                                            gpointer       *value);
+GLIB_AVAILABLE_IN_ALL
 GHashTable* g_hash_table_iter_get_hash_table (GHashTableIter *iter);
+GLIB_AVAILABLE_IN_ALL
 void        g_hash_table_iter_remove       (GHashTableIter *iter);
+GLIB_AVAILABLE_IN_2_30
+void        g_hash_table_iter_replace      (GHashTableIter *iter,
+                                            gpointer        value);
+GLIB_AVAILABLE_IN_ALL
 void        g_hash_table_iter_steal        (GHashTableIter *iter);
 
-/* keeping hash tables alive */
-GHashTable* g_hash_table_ref                      (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
+GHashTable* g_hash_table_ref               (GHashTable     *hash_table);
+GLIB_AVAILABLE_IN_ALL
 void        g_hash_table_unref             (GHashTable     *hash_table);
 
 #ifndef G_DISABLE_DEPRECATED
-
-/**
- * g_hash_table_freeze:
- * @hash_table: a #GHashTable
- *
- * This function is deprecated and will be removed in the next major
- * release of GLib. It does nothing.
- **/
 #define g_hash_table_freeze(hash_table) ((void)0)
-
-/**
- * g_hash_table_thaw:
- * @hash_table: a #GHashTable
- *
- * This function is deprecated and will be removed in the next major
- * release of GLib. It does nothing.
- **/
 #define g_hash_table_thaw(hash_table) ((void)0)
-
-#endif /* G_DISABLE_DEPRECATED */
+#endif
 
 /* Hash Functions
  */
-gboolean g_str_equal (gconstpointer  v1,
-                      gconstpointer  v2);
-guint    g_str_hash  (gconstpointer  v);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_str_equal    (gconstpointer  v1,
+                         gconstpointer  v2);
+GLIB_AVAILABLE_IN_ALL
+guint    g_str_hash     (gconstpointer  v);
 
-gboolean g_int_equal (gconstpointer  v1,
-                      gconstpointer  v2);
-guint    g_int_hash  (gconstpointer  v);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_int_equal    (gconstpointer  v1,
+                         gconstpointer  v2);
+GLIB_AVAILABLE_IN_ALL
+guint    g_int_hash     (gconstpointer  v);
 
-gboolean g_int64_equal (gconstpointer  v1,
-                        gconstpointer  v2);
-guint    g_int64_hash  (gconstpointer  v);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_int64_equal  (gconstpointer  v1,
+                         gconstpointer  v2);
+GLIB_AVAILABLE_IN_ALL
+guint    g_int64_hash   (gconstpointer  v);
 
+GLIB_AVAILABLE_IN_ALL
 gboolean g_double_equal (gconstpointer  v1,
                          gconstpointer  v2);
+GLIB_AVAILABLE_IN_ALL
 guint    g_double_hash  (gconstpointer  v);
 
-/* This "hash" function will just return the key's address as an
- * unsigned integer. Useful for hashing on plain addresses or
- * simple integer values.
- * Passing NULL into g_hash_table_new() as GHashFunc has the
- * same effect as passing g_direct_hash().
- */
+GLIB_AVAILABLE_IN_ALL
 guint    g_direct_hash  (gconstpointer  v) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
 gboolean g_direct_equal (gconstpointer  v1,
                          gconstpointer  v2) G_GNUC_CONST;