D-Bus  1.13.7
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 
40 
50 {
51  void *dummy1;
52  void *dummy2;
53  void *dummy3;
54  void *dummy4;
55  int dummy5;
56  int dummy6;
57 };
58 
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 {
72 } DBusHashType;
73 
74 DBUS_PRIVATE_EXPORT
76  DBusFreeFunction key_free_function,
77  DBusFreeFunction value_free_function);
79 DBUS_PRIVATE_EXPORT
82 DBUS_PRIVATE_EXPORT
84  DBusHashIter *iter);
85 DBUS_PRIVATE_EXPORT
87 DBUS_PRIVATE_EXPORT
89 DBUS_PRIVATE_EXPORT
91 DBUS_PRIVATE_EXPORT
93  void *value);
94 DBUS_PRIVATE_EXPORT
96 DBUS_PRIVATE_EXPORT
98 DBUS_PRIVATE_EXPORT
100 DBUS_PRIVATE_EXPORT
102  void *key,
103  dbus_bool_t create_if_not_found,
104  DBusHashIter *iter);
105 DBUS_PRIVATE_EXPORT
107  const char *key);
108 DBUS_PRIVATE_EXPORT
110  int key);
111 DBUS_PRIVATE_EXPORT
113  uintptr_t key);
114 DBUS_PRIVATE_EXPORT
116  const char *key);
117 DBUS_PRIVATE_EXPORT
119  int key);
120 DBUS_PRIVATE_EXPORT
122  uintptr_t key);
123 DBUS_PRIVATE_EXPORT
125  char *key,
126  void *value);
127 DBUS_PRIVATE_EXPORT
129  int key,
130  void *value);
131 DBUS_PRIVATE_EXPORT
133  uintptr_t key,
134  void *value);
135 DBUS_PRIVATE_EXPORT
137 
138 DBUS_PRIVATE_EXPORT
140  char delimiter);
141 DBUS_PRIVATE_EXPORT
143  char **array,
144  char delimiter);
145 
146 /* Preallocation */
147 
150 
151 DBUS_PRIVATE_EXPORT
153 DBUS_PRIVATE_EXPORT
155  DBusPreallocatedHash *preallocated);
156 DBUS_PRIVATE_EXPORT
158  DBusPreallocatedHash *preallocated,
159  char *key,
160  void *value);
161 
162 #ifdef DBUS_WIN
163 # define DBUS_HASH_POLLABLE DBUS_HASH_UINTPTR
164 #else
165 # define DBUS_HASH_POLLABLE DBUS_HASH_INT
166 #endif
167 
168 static inline DBusPollable
169 _dbus_hash_iter_get_pollable_key (DBusHashIter *iter)
170 {
171 #ifdef DBUS_WIN
172  DBusSocket s;
173 
174  s.sock = _dbus_hash_iter_get_uintptr_key (iter);
175  return s;
176 #else
177  return _dbus_hash_iter_get_int_key (iter);
178 #endif
179 }
180 
181 static inline void *
182 _dbus_hash_table_lookup_pollable (DBusHashTable *table,
183  DBusPollable key)
184 {
185 #ifdef DBUS_WIN
186  return _dbus_hash_table_lookup_uintptr (table, key.sock);
187 #else
188  return _dbus_hash_table_lookup_int (table, key);
189 #endif
190 }
191 
192 static inline dbus_bool_t
193 _dbus_hash_table_remove_pollable (DBusHashTable *table,
194  DBusPollable key)
195 {
196 #ifdef DBUS_WIN
197  return _dbus_hash_table_remove_uintptr (table, key.sock);
198 #else
199  return _dbus_hash_table_remove_int (table, key);
200 #endif
201 }
202 
203 static inline dbus_bool_t
204 _dbus_hash_table_insert_pollable (DBusHashTable *table,
205  DBusPollable key,
206  void *value)
207 {
208 #ifdef DBUS_WIN
209  return _dbus_hash_table_insert_uintptr (table, key.sock, value);
210 #else
211  return _dbus_hash_table_insert_int (table, key, value);
212 #endif
213 }
214 
215 static inline void
216 _dbus_clear_hash_table (DBusHashTable **table_p)
217 {
218  _dbus_clear_pointer_impl (DBusHashTable, table_p, _dbus_hash_table_unref);
219 }
220 
224 
225 #endif /* DBUS_HASH_H */
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:1110
void * dummy2
Do not use.
Definition: dbus-hash.h:52
struct DBusPreallocatedHash DBusPreallocatedHash
A preallocated hash entry.
Definition: dbus-hash.h:149
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
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:1333
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
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:1259
void * dummy1
Do not use.
Definition: dbus-hash.h:51
void _dbus_hash_iter_set_value(DBusHashIter *iter, void *value)
Sets the value of the current entry.
Definition: dbus-hash.c:637
const char * _dbus_hash_iter_get_string_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:697
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:1300
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:362
DBusHashTable * _dbus_hash_table_ref(DBusHashTable *table)
Increments the reference count for a hash table.
Definition: dbus-hash.c:348
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:544
void * dummy3
Do not use.
Definition: dbus-hash.h:53
Hash keys are strings.
Definition: dbus-hash.h:69
int dummy5
Do not use.
Definition: dbus-hash.h:55
Hash keys are integer capable to hold a pointer.
Definition: dbus-hash.h:71
Hash iterator object.
Definition: dbus-hash.h:49
void _dbus_hash_table_remove_all(DBusHashTable *table)
Removed all entries from a hash table.
Definition: dbus-hash.c:419
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:1426
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:1377
dbus_bool_t _dbus_hash_table_remove_int(DBusHashTable *table, int key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1162
Socket interface.
Definition: dbus-sysdeps.h:178
Hash keys are integers.
Definition: dbus-hash.h:70
int _dbus_hash_table_get_n_entries(DBusHashTable *table)
Gets the number of hash entries in a hash table.
Definition: dbus-hash.c:1408
void * _dbus_hash_iter_get_value(DBusHashIter *iter)
Gets the value of the current entry.
Definition: dbus-hash.c:614
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
uintptr_t _dbus_hash_iter_get_uintptr_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:679
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:1225
void _dbus_hash_iter_remove_entry(DBusHashIter *iter)
Removes the current entry from the hash table.
Definition: dbus-hash.c:593
int dummy6
Do not use.
Definition: dbus-hash.h:56
DBusHashType
Indicates the type of a key in the hash table.
Definition: dbus-hash.h:67
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:1134
void _dbus_hash_iter_init(DBusHashTable *table, DBusHashIter *iter)
Initializes a hash table iterator.
Definition: dbus-hash.c:518
char ** _dbus_hash_table_to_array(DBusHashTable *table, char delimiter)
Creates a string array from a hash table.
Definition: dbus-hash.c:1491
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:1060
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:1085
int _dbus_hash_iter_get_int_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:660
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:1350
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:742
Internals of DBusHashTable.
Definition: dbus-hash.c:169
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:1190
DBusHashTable * _dbus_hash_table_new(DBusHashType type, DBusFreeFunction key_free_function, DBusFreeFunction value_free_function)
Constructs a new hash table.
Definition: dbus-hash.c:286
void * dummy4
Do not use.
Definition: dbus-hash.h:54
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.