mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-26 07:26:15 +01:00
d68e7bc84a
Add functions to steal all the keys or values from a ghash (especially useful when it's used as a set), passing the ownership of then to a GPtrArray container that preserves the destroy notify functions.
207 lines
8.4 KiB
C
207 lines
8.4 KiB
C
/* GLIB - Library of useful routines for C programming
|
|
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1-or-later
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* 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
|
|
* 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, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
* Modified by the GLib Team and others 1997-2000. See the AUTHORS
|
|
* file for a list of people on the GLib Team. See the ChangeLog
|
|
* files for a list of changes. These files are distributed with
|
|
* GLib at ftp://ftp.gtk.org/pub/gtk/.
|
|
*/
|
|
|
|
#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/garray.h>
|
|
#include <glib/glist.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
typedef struct _GHashTable GHashTable;
|
|
|
|
typedef gboolean (*GHRFunc) (gpointer key,
|
|
gpointer value,
|
|
gpointer user_data);
|
|
|
|
typedef struct _GHashTableIter GHashTableIter;
|
|
|
|
struct _GHashTableIter
|
|
{
|
|
/*< private >*/
|
|
gpointer dummy1;
|
|
gpointer dummy2;
|
|
gpointer dummy3;
|
|
int dummy4;
|
|
gboolean dummy5;
|
|
gpointer dummy6;
|
|
};
|
|
|
|
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_2_72
|
|
GHashTable *g_hash_table_new_similar (GHashTable *other_hash_table);
|
|
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);
|
|
GLIB_AVAILABLE_IN_2_58
|
|
gboolean g_hash_table_steal_extended (GHashTable *hash_table,
|
|
gconstpointer lookup_key,
|
|
gpointer *stolen_key,
|
|
gpointer *stolen_value);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_hash_table_steal_all (GHashTable *hash_table);
|
|
GLIB_AVAILABLE_IN_2_76
|
|
GPtrArray * g_hash_table_steal_all_keys (GHashTable *hash_table);
|
|
GLIB_AVAILABLE_IN_2_76
|
|
GPtrArray * g_hash_table_steal_all_values (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_2_76
|
|
GPtrArray * g_hash_table_get_keys_as_ptr_array (GHashTable *hash_table);
|
|
|
|
GLIB_AVAILABLE_IN_2_76
|
|
GPtrArray * g_hash_table_get_values_as_ptr_array (GHashTable *hash_table);
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_hash_table_iter_init (GHashTableIter *iter,
|
|
GHashTable *hash_table);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_hash_table_iter_next (GHashTableIter *iter,
|
|
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);
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GHashTable* g_hash_table_ref (GHashTable *hash_table);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_hash_table_unref (GHashTable *hash_table);
|
|
|
|
#define g_hash_table_freeze(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
|
|
#define g_hash_table_thaw(hash_table) ((void)0) GLIB_DEPRECATED_MACRO_IN_2_26
|
|
|
|
/* Hash Functions
|
|
*/
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_str_equal (gconstpointer v1,
|
|
gconstpointer v2);
|
|
|
|
/* Macro for optimization in the case it is not used as callback function */
|
|
#define g_str_equal(v1, v2) (strcmp ((const char *) (v1), (const char *) (v2)) == 0)
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
guint g_str_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);
|
|
|
|
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);
|
|
|
|
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;
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_HASH_H__ */
|