1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-hash.h Generic hash table utility (internal to D-Bus implementation)
4 * Copyright (C) 2002 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <dbus/dbus-memory.h>
28 #include <dbus/dbus-types.h>
33 * @addtogroup DBusHashTable
37 /** Hash iterator object. The iterator is on the stack, but its real
38 * fields are hidden privately.
42 void *dummy1; /**< Do not use. */
43 void *dummy2; /**< Do not use. */
44 void *dummy3; /**< Do not use. */
45 void *dummy4; /**< Do not use. */
46 int dummy5; /**< Do not use. */
47 int dummy6; /**< Do not use. */
50 typedef struct DBusHashTable DBusHashTable;
51 typedef struct DBusHashIter DBusHashIter;
53 /* Allowing an arbitrary function as with GLib
54 * would be nicer for a public API, but for
55 * an internal API this saves typing, we can add
56 * more whenever we feel like it.
60 DBUS_HASH_STRING, /**< Hash keys are strings. */
61 DBUS_HASH_TWO_STRINGS, /**< Hash key is two strings in one memory block, i.e. foo\\0bar\\0 */
62 DBUS_HASH_INT, /**< Hash keys are integers. */
63 DBUS_HASH_POINTER, /**< Hash keys are pointers. */
64 DBUS_HASH_ULONG /**< Hash keys are unsigned long. */
67 DBusHashTable* _dbus_hash_table_new (DBusHashType type,
68 DBusFreeFunction key_free_function,
69 DBusFreeFunction value_free_function);
70 DBusHashTable* _dbus_hash_table_ref (DBusHashTable *table);
71 void _dbus_hash_table_unref (DBusHashTable *table);
72 void _dbus_hash_table_remove_all (DBusHashTable *table);
73 void _dbus_hash_iter_init (DBusHashTable *table,
75 dbus_bool_t _dbus_hash_iter_next (DBusHashIter *iter);
76 void _dbus_hash_iter_remove_entry (DBusHashIter *iter);
77 void* _dbus_hash_iter_get_value (DBusHashIter *iter);
78 void _dbus_hash_iter_set_value (DBusHashIter *iter,
80 int _dbus_hash_iter_get_int_key (DBusHashIter *iter);
81 const char* _dbus_hash_iter_get_string_key (DBusHashIter *iter);
82 const char* _dbus_hash_iter_get_two_strings_key (DBusHashIter *iter);
83 unsigned long _dbus_hash_iter_get_ulong_key (DBusHashIter *iter);
84 dbus_bool_t _dbus_hash_iter_lookup (DBusHashTable *table,
86 dbus_bool_t create_if_not_found,
88 void* _dbus_hash_table_lookup_string (DBusHashTable *table,
90 void* _dbus_hash_table_lookup_two_strings (DBusHashTable *table,
92 void* _dbus_hash_table_lookup_int (DBusHashTable *table,
94 void* _dbus_hash_table_lookup_pointer (DBusHashTable *table,
96 void* _dbus_hash_table_lookup_ulong (DBusHashTable *table,
98 dbus_bool_t _dbus_hash_table_remove_string (DBusHashTable *table,
100 dbus_bool_t _dbus_hash_table_remove_two_strings (DBusHashTable *table,
102 dbus_bool_t _dbus_hash_table_remove_int (DBusHashTable *table,
104 dbus_bool_t _dbus_hash_table_remove_pointer (DBusHashTable *table,
106 dbus_bool_t _dbus_hash_table_remove_ulong (DBusHashTable *table,
108 dbus_bool_t _dbus_hash_table_insert_string (DBusHashTable *table,
111 dbus_bool_t _dbus_hash_table_insert_two_strings (DBusHashTable *table,
114 dbus_bool_t _dbus_hash_table_insert_int (DBusHashTable *table,
117 dbus_bool_t _dbus_hash_table_insert_pointer (DBusHashTable *table,
120 dbus_bool_t _dbus_hash_table_insert_ulong (DBusHashTable *table,
123 int _dbus_hash_table_get_n_entries (DBusHashTable *table);
126 typedef struct DBusPreallocatedHash DBusPreallocatedHash;
128 DBusPreallocatedHash *_dbus_hash_table_preallocate_entry (DBusHashTable *table);
129 void _dbus_hash_table_free_preallocated_entry (DBusHashTable *table,
130 DBusPreallocatedHash *preallocated);
131 void _dbus_hash_table_insert_string_preallocated (DBusHashTable *table,
132 DBusPreallocatedHash *preallocated,
140 #endif /* DBUS_HASH_H */