D-Bus 1.15.2
dbus-hash.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-hash.h Generic hash table utility (internal to D-Bus implementation)
3 *
4 * Copyright (C) 2002 Red Hat, Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
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.
12 *
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.
17 *
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23
24#ifndef DBUS_HASH_H
25#define DBUS_HASH_H
26
27#include <stdint.h>
28
29#ifdef HAVE_INTTYPES_H
30#include <inttypes.h>
31#endif
32
33#include <dbus/dbus-memory.h>
34#include <dbus/dbus-types.h>
35#include <dbus/dbus-sysdeps.h>
36
38
48{
49 void *dummy1;
50 void *dummy2;
51 void *dummy3;
52 void *dummy4;
53 int dummy5;
54 int dummy6;
55};
56
59
60/* Allowing an arbitrary function as with GLib
61 * would be nicer for a public API, but for
62 * an internal API this saves typing, we can add
63 * more whenever we feel like it.
64 */
65typedef enum
66{
71
72DBUS_PRIVATE_EXPORT
74 DBusFreeFunction key_free_function,
75 DBusFreeFunction value_free_function);
76DBUS_PRIVATE_EXPORT
78DBUS_PRIVATE_EXPORT
81DBUS_PRIVATE_EXPORT
83 DBusHashIter *iter);
84DBUS_PRIVATE_EXPORT
86DBUS_PRIVATE_EXPORT
88DBUS_PRIVATE_EXPORT
90DBUS_PRIVATE_EXPORT
92 void *value);
93DBUS_PRIVATE_EXPORT
95DBUS_PRIVATE_EXPORT
97DBUS_PRIVATE_EXPORT
99DBUS_PRIVATE_EXPORT
101 void *key,
102 dbus_bool_t create_if_not_found,
103 DBusHashIter *iter);
104DBUS_PRIVATE_EXPORT
106 const char *key);
107DBUS_PRIVATE_EXPORT
109 int key);
110DBUS_PRIVATE_EXPORT
112 uintptr_t key);
113DBUS_PRIVATE_EXPORT
115 const char *key);
116DBUS_PRIVATE_EXPORT
118 int key);
119DBUS_PRIVATE_EXPORT
121 uintptr_t key);
122DBUS_PRIVATE_EXPORT
124 char *key,
125 void *value);
126DBUS_PRIVATE_EXPORT
128 int key,
129 void *value);
130DBUS_PRIVATE_EXPORT
132 uintptr_t key,
133 void *value);
134DBUS_PRIVATE_EXPORT
136
137DBUS_PRIVATE_EXPORT
139 char delimiter);
140DBUS_PRIVATE_EXPORT
142 char **array,
143 char delimiter);
144
145/* Preallocation */
146
149
150DBUS_PRIVATE_EXPORT
152DBUS_PRIVATE_EXPORT
154 DBusPreallocatedHash *preallocated);
155DBUS_PRIVATE_EXPORT
157 DBusPreallocatedHash *preallocated,
158 char *key,
159 void *value);
160
161#ifdef DBUS_WIN
162# define DBUS_HASH_POLLABLE DBUS_HASH_UINTPTR
163#else
164# define DBUS_HASH_POLLABLE DBUS_HASH_INT
165#endif
166
167static inline DBusPollable
168_dbus_hash_iter_get_pollable_key (DBusHashIter *iter)
169{
170#ifdef DBUS_WIN
171 DBusSocket s;
172
173 s.sock = _dbus_hash_iter_get_uintptr_key (iter);
174 return s;
175#else
176 return _dbus_hash_iter_get_int_key (iter);
177#endif
178}
179
180static inline void *
181_dbus_hash_table_lookup_pollable (DBusHashTable *table,
182 DBusPollable key)
183{
184#ifdef DBUS_WIN
185 return _dbus_hash_table_lookup_uintptr (table, key.sock);
186#else
187 return _dbus_hash_table_lookup_int (table, key);
188#endif
189}
190
191static inline dbus_bool_t
192_dbus_hash_table_remove_pollable (DBusHashTable *table,
193 DBusPollable key)
194{
195#ifdef DBUS_WIN
196 return _dbus_hash_table_remove_uintptr (table, key.sock);
197#else
198 return _dbus_hash_table_remove_int (table, key);
199#endif
200}
201
202static inline dbus_bool_t
203_dbus_hash_table_insert_pollable (DBusHashTable *table,
204 DBusPollable key,
205 void *value)
206{
207#ifdef DBUS_WIN
208 return _dbus_hash_table_insert_uintptr (table, key.sock, value);
209#else
210 return _dbus_hash_table_insert_int (table, key, value);
211#endif
212}
213
214static inline void
215_dbus_clear_hash_table (DBusHashTable **table_p)
216{
217 _dbus_clear_pointer_impl (DBusHashTable, table_p, _dbus_hash_table_unref);
218}
219
223
224#endif /* DBUS_HASH_H */
int _dbus_hash_table_get_n_entries(DBusHashTable *table)
Gets the number of hash entries in a hash table.
Definition: dbus-hash.c:1460
DBusHashTable * _dbus_hash_table_ref(DBusHashTable *table)
Increments the reference count for a hash table.
Definition: dbus-hash.c:353
dbus_bool_t _dbus_hash_table_remove_uintptr(DBusHashTable *table, uintptr_t key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1242
void * _dbus_hash_iter_get_value(DBusHashIter *iter)
Gets the value of the current entry.
Definition: dbus-hash.c:619
struct DBusPreallocatedHash DBusPreallocatedHash
A preallocated hash entry.
Definition: dbus-hash.h:148
dbus_bool_t _dbus_hash_table_insert_int(DBusHashTable *table, int key, void *value)
Creates a hash entry with the given key and value.
Definition: dbus-hash.c:1311
dbus_bool_t _dbus_hash_table_insert_string(DBusHashTable *table, char *key, void *value)
Creates a hash entry with the given key and value.
Definition: dbus-hash.c:1277
dbus_bool_t _dbus_hash_table_from_array(DBusHashTable *table, char **array, char delimiter)
Imports a string array into a hash table The hash table needs to be initialized with string keys,...
Definition: dbus-hash.c:1478
uintptr_t _dbus_hash_iter_get_uintptr_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:684
void * _dbus_hash_table_lookup_uintptr(DBusHashTable *table, uintptr_t key)
Looks up the value for a given integer in a hash table of type DBUS_HASH_UINTPTR.
Definition: dbus-hash.c:1162
void _dbus_hash_table_unref(DBusHashTable *table)
Decrements the reference count for a hash table, freeing the hash table if the count reaches zero.
Definition: dbus-hash.c:367
dbus_bool_t _dbus_hash_iter_next(DBusHashIter *iter)
Move the hash iterator forward one step, to the next hash entry.
Definition: dbus-hash.c:549
int _dbus_hash_iter_get_int_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:665
void _dbus_hash_iter_init(DBusHashTable *table, DBusHashIter *iter)
Initializes a hash table iterator.
Definition: dbus-hash.c:523
void _dbus_hash_table_free_preallocated_entry(DBusHashTable *table, DBusPreallocatedHash *preallocated)
Frees an opaque DBusPreallocatedHash that was not used in order to insert into the hash table.
Definition: dbus-hash.c:1402
DBusHashTable * _dbus_hash_table_new(DBusHashType type, DBusFreeFunction key_free_function, DBusFreeFunction value_free_function)
Constructs a new hash table.
Definition: dbus-hash.c:291
dbus_bool_t _dbus_hash_table_remove_int(DBusHashTable *table, int key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1214
DBusPreallocatedHash * _dbus_hash_table_preallocate_entry(DBusHashTable *table)
Preallocate an opaque data blob that allows us to insert into the hash table at a later time without ...
Definition: dbus-hash.c:1385
dbus_bool_t _dbus_hash_table_remove_string(DBusHashTable *table, const char *key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1186
char ** _dbus_hash_table_to_array(DBusHashTable *table, char delimiter)
Creates a string array from a hash table.
Definition: dbus-hash.c:1543
void _dbus_hash_iter_set_value(DBusHashIter *iter, void *value)
Sets the value of the current entry.
Definition: dbus-hash.c:642
DBusHashType
Indicates the type of a key in the hash table.
Definition: dbus-hash.h:66
void * _dbus_hash_table_lookup_string(DBusHashTable *table, const char *key)
Looks up the value for a given string in a hash table of type DBUS_HASH_STRING.
Definition: dbus-hash.c:1112
dbus_bool_t _dbus_hash_iter_lookup(DBusHashTable *table, void *key, dbus_bool_t create_if_not_found, DBusHashIter *iter)
A low-level but efficient interface for manipulating the hash table.
Definition: dbus-hash.c:747
void _dbus_hash_table_remove_all(DBusHashTable *table)
Removed all entries from a hash table.
Definition: dbus-hash.c:424
const char * _dbus_hash_iter_get_string_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:702
dbus_bool_t _dbus_hash_table_insert_uintptr(DBusHashTable *table, uintptr_t key, void *value)
Creates a hash entry with the given key and value.
Definition: dbus-hash.c:1352
void _dbus_hash_iter_remove_entry(DBusHashIter *iter)
Removes the current entry from the hash table.
Definition: dbus-hash.c:598
void _dbus_hash_table_insert_string_preallocated(DBusHashTable *table, DBusPreallocatedHash *preallocated, char *key, void *value)
Inserts a string-keyed entry into the hash table, using a preallocated data block from _dbus_hash_tab...
Definition: dbus-hash.c:1429
void * _dbus_hash_table_lookup_int(DBusHashTable *table, int key)
Looks up the value for a given integer in a hash table of type DBUS_HASH_INT.
Definition: dbus-hash.c:1137
@ DBUS_HASH_INT
Hash keys are integers.
Definition: dbus-hash.h:68
@ DBUS_HASH_UINTPTR
Hash keys are integer capable to hold a pointer.
Definition: dbus-hash.h:69
@ DBUS_HASH_STRING
Hash keys are strings.
Definition: dbus-hash.h:67
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
Hash iterator object.
Definition: dbus-hash.h:48
void * dummy1
Do not use.
Definition: dbus-hash.h:49
void * dummy4
Do not use.
Definition: dbus-hash.h:52
int dummy5
Do not use.
Definition: dbus-hash.h:53
int dummy6
Do not use.
Definition: dbus-hash.h:54
void * dummy3
Do not use.
Definition: dbus-hash.h:51
void * dummy2
Do not use.
Definition: dbus-hash.h:50
Internals of DBusHashTable.
Definition: dbus-hash.c:174
Socket interface.
Definition: dbus-sysdeps.h:179