D-Bus  1.12.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 #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
92  void *value);
93 DBUS_PRIVATE_EXPORT
95 DBUS_PRIVATE_EXPORT
97 DBUS_PRIVATE_EXPORT
100  void *key,
101  dbus_bool_t create_if_not_found,
102  DBusHashIter *iter);
103 DBUS_PRIVATE_EXPORT
105  const char *key);
106 DBUS_PRIVATE_EXPORT
108  int key);
109 DBUS_PRIVATE_EXPORT
111  uintptr_t key);
112 DBUS_PRIVATE_EXPORT
114  const char *key);
115 DBUS_PRIVATE_EXPORT
117  int key);
118 DBUS_PRIVATE_EXPORT
120  uintptr_t key);
121 DBUS_PRIVATE_EXPORT
123  char *key,
124  void *value);
125 DBUS_PRIVATE_EXPORT
127  int key,
128  void *value);
129 DBUS_PRIVATE_EXPORT
131  uintptr_t key,
132  void *value);
133 DBUS_PRIVATE_EXPORT
135 
136 DBUS_PRIVATE_EXPORT
138  char delimiter);
139 DBUS_PRIVATE_EXPORT
141  char **array,
142  char delimiter);
143 
144 /* Preallocation */
145 
148 
149 DBUS_PRIVATE_EXPORT
151 DBUS_PRIVATE_EXPORT
153  DBusPreallocatedHash *preallocated);
154 DBUS_PRIVATE_EXPORT
156  DBusPreallocatedHash *preallocated,
157  char *key,
158  void *value);
159 
160 #ifdef DBUS_WIN
161 # define DBUS_HASH_POLLABLE DBUS_HASH_UINTPTR
162 #else
163 # define DBUS_HASH_POLLABLE DBUS_HASH_INT
164 #endif
165 
166 static inline DBusPollable
167 _dbus_hash_iter_get_pollable_key (DBusHashIter *iter)
168 {
169 #ifdef DBUS_WIN
170  DBusSocket s;
171 
172  s.sock = _dbus_hash_iter_get_uintptr_key (iter);
173  return s;
174 #else
175  return _dbus_hash_iter_get_int_key (iter);
176 #endif
177 }
178 
179 static inline void *
180 _dbus_hash_table_lookup_pollable (DBusHashTable *table,
181  DBusPollable key)
182 {
183 #ifdef DBUS_WIN
184  return _dbus_hash_table_lookup_uintptr (table, key.sock);
185 #else
186  return _dbus_hash_table_lookup_int (table, key);
187 #endif
188 }
189 
190 static inline dbus_bool_t
191 _dbus_hash_table_remove_pollable (DBusHashTable *table,
192  DBusPollable key)
193 {
194 #ifdef DBUS_WIN
195  return _dbus_hash_table_remove_uintptr (table, key.sock);
196 #else
197  return _dbus_hash_table_remove_int (table, key);
198 #endif
199 }
200 
201 static inline dbus_bool_t
202 _dbus_hash_table_insert_pollable (DBusHashTable *table,
203  DBusPollable key,
204  void *value)
205 {
206 #ifdef DBUS_WIN
207  return _dbus_hash_table_insert_uintptr (table, key.sock, value);
208 #else
209  return _dbus_hash_table_insert_int (table, key, value);
210 #endif
211 }
212 
213 static inline void
214 _dbus_clear_hash_table (DBusHashTable **table_p)
215 {
216  _dbus_clear_pointer_impl (DBusHashTable, table_p, _dbus_hash_table_unref);
217 }
218 
222 
223 #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:1109
void * dummy2
Do not use.
Definition: dbus-hash.h:52
struct DBusPreallocatedHash DBusPreallocatedHash
A preallocated hash entry.
Definition: dbus-hash.h:147
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:64
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:1332
#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:1258
void * dummy1
Do not use.
Definition: dbus-hash.h:51
const char * _dbus_hash_iter_get_string_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:696
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:1299
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
DBusHashTable * _dbus_hash_table_ref(DBusHashTable *table)
Increments the reference count for a hash table.
Definition: dbus-hash.c:347
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
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:418
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:1425
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:1376
dbus_bool_t _dbus_hash_table_remove_int(DBusHashTable *table, int key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1161
Socket interface.
Definition: dbus-sysdeps.h:149
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:1407
void * _dbus_hash_iter_get_value(DBusHashIter *iter)
Gets the value of the current entry.
Definition: dbus-hash.c:613
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:741
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:678
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:1224
void _dbus_hash_iter_remove_entry(DBusHashIter *iter)
Removes the current entry from the hash table.
Definition: dbus-hash.c:592
int dummy6
Do not use.
Definition: dbus-hash.h:56
void _dbus_hash_iter_set_value(DBusHashIter *iter, void *value)
Sets the value of the current entry.
Definition: dbus-hash.c:636
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:1133
void _dbus_hash_iter_init(DBusHashTable *table, DBusHashIter *iter)
Initializes a hash table iterator.
Definition: dbus-hash.c:517
char ** _dbus_hash_table_to_array(DBusHashTable *table, char delimiter)
Creates a string array from a hash table.
Definition: dbus-hash.c:1490
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:1059
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:1084
int _dbus_hash_iter_get_int_key(DBusHashIter *iter)
Gets the key for the current entry.
Definition: dbus-hash.c:659
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:1349
Internals of DBusHashTable.
Definition: dbus-hash.c:168
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:1189
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
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.