D-Bus: dbus-hash.h Source File

D-Bus 1.10.22

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 #ifdef HAVE_STDINT_H
28 #include <stdint.h>
29 #endif
30
31 #ifdef HAVE_INTTYPES_H
32 #include <inttypes.h>
33 #endif
34
35 #include <dbus/dbus-memory.h>
36 #include <dbus/dbus-types.h>
37 #include <dbus/dbus-sysdeps.h>
38
39 DBUS_BEGIN_DECLS
40
49 struct DBusHashIter
50 {
51 void *dummy1;
52 void *dummy2;
53 void *dummy3;
54 void *dummy4;
55 int dummy5;
56 int dummy6;
57 };
58
59 typedef struct DBusHashTable DBusHashTable;
60 typedef struct DBusHashIter DBusHashIter;
61
62 /* Allowing an arbitrary function as with GLib
63 * would be nicer for a public API, but for
64 * an internal API this saves typing, we can add
65 * more whenever we feel like it.
66 */
67 typedef enum
68 {
69 DBUS_HASH_STRING,
70 DBUS_HASH_INT,
71 DBUS_HASH_UINTPTR
72 } DBusHashType;
73
74 DBUS_PRIVATE_EXPORT
75 DBusHashTable* _dbus_hash_table_new (DBusHashType type,
76 DBusFreeFunction key_free_function,
77 DBusFreeFunction value_free_function);
78 DBusHashTable* _dbus_hash_table_ref (DBusHashTable *table);
79 DBUS_PRIVATE_EXPORT
80 void _dbus_hash_table_unref (DBusHashTable *table);
81 void _dbus_hash_table_remove_all (DBusHashTable *table);
82 DBUS_PRIVATE_EXPORT
83 void _dbus_hash_iter_init (DBusHashTable *table,
84 DBusHashIter *iter);
85 DBUS_PRIVATE_EXPORT
86 dbus_bool_t _dbus_hash_iter_next (DBusHashIter *iter);
87 DBUS_PRIVATE_EXPORT
88 void _dbus_hash_iter_remove_entry (DBusHashIter *iter);
89 DBUS_PRIVATE_EXPORT
90 void* _dbus_hash_iter_get_value (DBusHashIter *iter);
91 void _dbus_hash_iter_set_value (DBusHashIter *iter,
92 void *value);
93 DBUS_PRIVATE_EXPORT
94 int _dbus_hash_iter_get_int_key (DBusHashIter *iter);
95 DBUS_PRIVATE_EXPORT
96 const char* _dbus_hash_iter_get_string_key (DBusHashIter *iter);
97 DBUS_PRIVATE_EXPORT
98 uintptr_t _dbus_hash_iter_get_uintptr_key (DBusHashIter *iter);
99 dbus_bool_t _dbus_hash_iter_lookup (DBusHashTable *table,
100 void *key,
101 dbus_bool_t create_if_not_found,
102 DBusHashIter *iter);
103 DBUS_PRIVATE_EXPORT
104 void* _dbus_hash_table_lookup_string (DBusHashTable *table,
105 const char *key);
106 DBUS_PRIVATE_EXPORT
107 void* _dbus_hash_table_lookup_int (DBusHashTable *table,
108 int key);
109 DBUS_PRIVATE_EXPORT
110 void* _dbus_hash_table_lookup_uintptr (DBusHashTable *table,
111 uintptr_t key);
112 DBUS_PRIVATE_EXPORT
113 dbus_bool_t _dbus_hash_table_remove_string (DBusHashTable *table,
114 const char *key);
115 DBUS_PRIVATE_EXPORT
116 dbus_bool_t _dbus_hash_table_remove_int (DBusHashTable *table,
117 int key);
118 DBUS_PRIVATE_EXPORT
119 dbus_bool_t _dbus_hash_table_remove_uintptr (DBusHashTable *table,
120 uintptr_t key);
121 DBUS_PRIVATE_EXPORT
122 dbus_bool_t _dbus_hash_table_insert_string (DBusHashTable *table,
123 char *key,
124 void *value);
125 DBUS_PRIVATE_EXPORT
126 dbus_bool_t _dbus_hash_table_insert_int (DBusHashTable *table,
127 int key,
128 void *value);
129 DBUS_PRIVATE_EXPORT
130 dbus_bool_t _dbus_hash_table_insert_uintptr (DBusHashTable *table,
131 uintptr_t key,
132 void *value);
133 DBUS_PRIVATE_EXPORT
134 int _dbus_hash_table_get_n_entries (DBusHashTable *table);
135
136 /* Preallocation */
137
139 typedef struct DBusPreallocatedHash DBusPreallocatedHash;
140
141 DBUS_PRIVATE_EXPORT
142 DBusPreallocatedHash *_dbus_hash_table_preallocate_entry (DBusHashTable *table);
143 DBUS_PRIVATE_EXPORT
144 void _dbus_hash_table_free_preallocated_entry (DBusHashTable *table,
145 DBusPreallocatedHash *preallocated);
146 DBUS_PRIVATE_EXPORT
147 void _dbus_hash_table_insert_string_preallocated (DBusHashTable *table,
148 DBusPreallocatedHash *preallocated,
149 char *key,
150 void *value);
151
152 #ifdef DBUS_WIN
153 # define DBUS_HASH_POLLABLE DBUS_HASH_UINTPTR
154 #else
155 # define DBUS_HASH_POLLABLE DBUS_HASH_INT
156 #endif
157
158 static inline DBusPollable
159 _dbus_hash_iter_get_pollable_key (DBusHashIter *iter)
160 {
161 #ifdef DBUS_WIN
162 DBusSocket s;
163
164 s.sock = _dbus_hash_iter_get_uintptr_key (iter);
165 return s;
166 #else
167 return _dbus_hash_iter_get_int_key (iter);
168 #endif
169 }
170
171 static inline void *
172 _dbus_hash_table_lookup_pollable (DBusHashTable *table,
173 DBusPollable key)
174 {
175 #ifdef DBUS_WIN
176 return _dbus_hash_table_lookup_uintptr (table, key.sock);
177 #else
178 return _dbus_hash_table_lookup_int (table, key);
179 #endif
180 }
181
182 static inline dbus_bool_t
183 _dbus_hash_table_remove_pollable (DBusHashTable *table,
184 DBusPollable key)
185 {
186 #ifdef DBUS_WIN
187 return _dbus_hash_table_remove_uintptr (table, key.sock);
188 #else
189 return _dbus_hash_table_remove_int (table, key);
190 #endif
191 }
192
193 static inline dbus_bool_t
194 _dbus_hash_table_insert_pollable (DBusHashTable *table,
195 DBusPollable key,
196 void *value)
197 {
198 #ifdef DBUS_WIN
199 return _dbus_hash_table_insert_uintptr (table, key.sock, value);
200 #else
201 return _dbus_hash_table_insert_int (table, key, value);
202 #endif
203 }
204
207 DBUS_END_DECLS
208
209 #endif /* DBUS_HASH_H */
_dbus_hash_table_lookup_uintptr
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:1099
DBusHashIter::dummy2
void * dummy2
Do not use.
Definition: dbus-hash.h:52
DBusPreallocatedHash
struct DBusPreallocatedHash DBusPreallocatedHash
A preallocated hash entry.
Definition: dbus-hash.h:139
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:64
_dbus_hash_table_preallocate_entry
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:1322
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_dbus_hash_table_insert_int
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:1248
DBusHashIter::dummy1
void * dummy1
Do not use.
Definition: dbus-hash.h:51
_dbus_hash_iter_get_string_key
const char * _dbus_hash_iter_get_string_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:696
_dbus_hash_table_insert_uintptr
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:1289
_dbus_hash_table_unref
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:361
_dbus_hash_table_ref
DBusHashTable * _dbus_hash_table_ref(DBusHashTable *table)
Increments the reference count for a hash table.
Definition: dbus-hash.c:347
_dbus_hash_iter_next
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:543
DBusHashIter::dummy3
void * dummy3
Do not use.
Definition: dbus-hash.h:53
DBUS_HASH_STRING
Hash keys are strings.
Definition: dbus-hash.h:69
DBusHashIter::dummy5
int dummy5
Do not use.
Definition: dbus-hash.h:55
DBUS_HASH_UINTPTR
Hash keys are integer capable to hold a pointer.
Definition: dbus-hash.h:71
DBusHashIter
Hash iterator object.
Definition: dbus-hash.h:49
_dbus_hash_table_remove_all
void _dbus_hash_table_remove_all(DBusHashTable *table)
Removed all entries from a hash table.
Definition: dbus-hash.c:418
_dbus_hash_table_insert_string_preallocated
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:1366
_dbus_hash_table_remove_int
dbus_bool_t _dbus_hash_table_remove_int(DBusHashTable *table, int key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1151
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:148
DBUS_HASH_INT
Hash keys are integers.
Definition: dbus-hash.h:70
_dbus_hash_table_get_n_entries
int _dbus_hash_table_get_n_entries(DBusHashTable *table)
Gets the number of hash entries in a hash table.
Definition: dbus-hash.c:1397
_dbus_hash_iter_get_value
void * _dbus_hash_iter_get_value(DBusHashIter *iter)
Gets the value of the current entry.
Definition: dbus-hash.c:613
_dbus_hash_iter_lookup
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:740
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_hash_iter_get_uintptr_key
uintptr_t _dbus_hash_iter_get_uintptr_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:678
_dbus_hash_table_insert_string
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:1214
_dbus_hash_iter_remove_entry
void _dbus_hash_iter_remove_entry(DBusHashIter *iter)
Removes the current entry from the hash table.
Definition: dbus-hash.c:592
DBusHashIter::dummy6
int dummy6
Do not use.
Definition: dbus-hash.h:56
_dbus_hash_iter_set_value
void _dbus_hash_iter_set_value(DBusHashIter *iter, void *value)
Sets the value of the current entry.
Definition: dbus-hash.c:636
DBusHashType
DBusHashType
Indicates the type of a key in the hash table.
Definition: dbus-hash.h:67
_dbus_hash_table_remove_string
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:1123
_dbus_hash_iter_init
void _dbus_hash_iter_init(DBusHashTable *table, DBusHashIter *iter)
Initializes a hash table iterator.
Definition: dbus-hash.c:517
_dbus_hash_table_lookup_string
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:1049
_dbus_hash_table_lookup_int
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:1074
_dbus_hash_iter_get_int_key
int _dbus_hash_iter_get_int_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:659
_dbus_hash_table_free_preallocated_entry
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:1339
DBusHashTable
Internals of DBusHashTable.
Definition: dbus-hash.c:168
_dbus_hash_table_remove_uintptr
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:1179
_dbus_hash_table_new
DBusHashTable * _dbus_hash_table_new(DBusHashType type, DBusFreeFunction key_free_function, DBusFreeFunction value_free_function)
Constructs a new hash table.
Definition: dbus-hash.c:285
DBusHashIter::dummy4
void * dummy4
Do not use.
Definition: dbus-hash.h:54
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.