williamr@2: /* GLIB - Library of useful routines for C programming
williamr@2:  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
williamr@2:  * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2:  *
williamr@2:  * This library is free software; you can redistribute it and/or
williamr@2:  * modify it under the terms of the GNU Lesser General Public
williamr@2:  * License as published by the Free Software Foundation; either
williamr@2:  * version 2 of the License, or (at your option) any later version.
williamr@2:  *
williamr@2:  * This library is distributed in the hope that it will be useful,
williamr@2:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
williamr@2:  * Lesser General Public License for more details.
williamr@2:  *
williamr@2:  * You should have received a copy of the GNU Lesser General Public
williamr@2:  * License along with this library; if not, write to the
williamr@2:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
williamr@2:  * Boston, MA 02111-1307, USA.
williamr@2:  */
williamr@2: 
williamr@2: /*
williamr@2:  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
williamr@2:  * file for a list of people on the GLib Team.  See the ChangeLog
williamr@2:  * files for a list of changes.  These files are distributed with
williamr@2:  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
williamr@2:  */
williamr@2: 
williamr@2: #ifndef __G_HASH_H__
williamr@2: #define __G_HASH_H__
williamr@2: 
williamr@2: #include <_ansi.h>
williamr@2: #include <glib/gtypes.h>
williamr@2: 
williamr@2: G_BEGIN_DECLS
williamr@2: 
williamr@2: typedef struct _GHashTable  GHashTable;
williamr@2: 
williamr@2: typedef gboolean  (*GHRFunc)  (gpointer  key,
williamr@2:                                gpointer  value,
williamr@2:                                gpointer  user_data);
williamr@2: 
williamr@2: /* Hash tables
williamr@2:  */
williamr@2: IMPORT_C GHashTable* g_hash_table_new		   (GHashFunc	    hash_func,
williamr@2: 					    GEqualFunc	    key_equal_func);
williamr@2: IMPORT_C GHashTable* g_hash_table_new_full      	   (GHashFunc	    hash_func,
williamr@2: 					    GEqualFunc	    key_equal_func,
williamr@2: 					    GDestroyNotify  key_destroy_func,
williamr@2: 					    GDestroyNotify  value_destroy_func);
williamr@2: IMPORT_C void	    g_hash_table_destroy	   (GHashTable	   *hash_table);
williamr@2: IMPORT_C void	    g_hash_table_insert		   (GHashTable	   *hash_table,
williamr@2: 					    gpointer	    key,
williamr@2: 					    gpointer	    value);
williamr@2: IMPORT_C void        g_hash_table_replace           (GHashTable     *hash_table,
williamr@2: 					    gpointer	    key,
williamr@2: 					    gpointer	    value);
williamr@2: IMPORT_C gboolean    g_hash_table_remove		   (GHashTable	   *hash_table,
williamr@2: 					    gconstpointer   key);
williamr@2: IMPORT_C gboolean    g_hash_table_steal             (GHashTable     *hash_table,
williamr@2: 					    gconstpointer   key);
williamr@2: IMPORT_C gpointer    g_hash_table_lookup		   (GHashTable	   *hash_table,
williamr@2: 					    gconstpointer   key);
williamr@2: IMPORT_C gboolean    g_hash_table_lookup_extended   (GHashTable	   *hash_table,
williamr@2: 					    gconstpointer   lookup_key,
williamr@2: 					    gpointer	   *orig_key,
williamr@2: 					    gpointer	   *value);
williamr@2: IMPORT_C void	    g_hash_table_foreach	   (GHashTable	   *hash_table,
williamr@2: 					    GHFunc	    func,
williamr@2: 					    gpointer	    user_data);
williamr@2: IMPORT_C gpointer    g_hash_table_find	   (GHashTable	   *hash_table,
williamr@2: 					    GHRFunc	    predicate,
williamr@2: 					    gpointer	    user_data);
williamr@2: IMPORT_C guint	    g_hash_table_foreach_remove	   (GHashTable	   *hash_table,
williamr@2: 					    GHRFunc	    func,
williamr@2: 					    gpointer	    user_data);
williamr@2: IMPORT_C guint	    g_hash_table_foreach_steal	   (GHashTable	   *hash_table,
williamr@2: 					    GHRFunc	    func,
williamr@2: 					    gpointer	    user_data);
williamr@2: IMPORT_C guint	    g_hash_table_size		   (GHashTable	   *hash_table);
williamr@2: 
williamr@2: /* keeping hash tables alive */
williamr@2: IMPORT_C GHashTable* g_hash_table_ref   		   (GHashTable 	   *hash_table);
williamr@2: IMPORT_C void        g_hash_table_unref             (GHashTable     *hash_table);
williamr@2: 
williamr@2: #ifndef G_DISABLE_DEPRECATED
williamr@2: 
williamr@2: /* The following two functions are deprecated and will be removed in
williamr@2:  * the next major release. They do no good. */
williamr@2: #define g_hash_table_freeze(hash_table) ((void)0)
williamr@2: #define g_hash_table_thaw(hash_table) ((void)0)
williamr@2: 
williamr@2: #endif /* G_DISABLE_DEPRECATED */
williamr@2: 
williamr@2: /* Hash Functions
williamr@2:  */
williamr@2: IMPORT_C gboolean g_str_equal (gconstpointer  v1,
williamr@2:                       gconstpointer  v2);
williamr@2: IMPORT_C guint    g_str_hash  (gconstpointer  v);
williamr@2: 
williamr@2: IMPORT_C gboolean g_int_equal (gconstpointer  v1,
williamr@2:                       gconstpointer  v2);
williamr@2: IMPORT_C guint    g_int_hash  (gconstpointer  v);
williamr@2: 
williamr@2: /* This "hash" function will just return the key's address as an
williamr@2:  * unsigned integer. Useful for hashing on plain addresses or
williamr@2:  * simple integer values.
williamr@2:  * Passing NULL into g_hash_table_new() as GHashFunc has the
williamr@2:  * same effect as passing g_direct_hash().
williamr@2:  */
williamr@2: IMPORT_C guint    g_direct_hash  (gconstpointer  v) G_GNUC_CONST;
williamr@2: IMPORT_C gboolean g_direct_equal (gconstpointer  v1,
williamr@2:                          gconstpointer  v2) G_GNUC_CONST;
williamr@2: 
williamr@2: G_END_DECLS
williamr@2: 
williamr@2: #endif /* __G_HASH_H__ */
williamr@2: