5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
25 #include <pulsecore/idxset.h>
27 /* Simple Implementation of a hash table. Memory management is the
28 * user's job. It's a good idea to have the key pointer point to a
29 * string in the value data. */
31 typedef struct pa_hashmap pa_hashmap
;
33 typedef void (*pa_free2_cb_t
)(void *p
, void *userdata
);
35 /* Create a new hashmap. Use the specified functions for hashing and comparing objects in the map */
36 pa_hashmap
*pa_hashmap_new(pa_hash_func_t hash_func
, pa_compare_func_t compare_func
);
38 /* Free the hash table. Calls the specified function for every value in the table. The function may be NULL */
39 void pa_hashmap_free(pa_hashmap
*, pa_free2_cb_t free_cb
, void *userdata
);
41 /* Returns non-zero when the entry already exists */
42 int pa_hashmap_put(pa_hashmap
*h
, const void *key
, void *value
);
43 void* pa_hashmap_get(pa_hashmap
*h
, const void *key
);
45 /* Returns the data of the entry while removing */
46 void* pa_hashmap_remove(pa_hashmap
*h
, const void *key
);
48 unsigned pa_hashmap_size(pa_hashmap
*h
);
50 /* May be used to iterate through the hashmap. Initially the opaque
51 pointer *state has to be set to NULL. The hashmap may not be
52 modified during iteration -- except for deleting the current entry
53 via pa_hashmap_remove(). The key of the entry is returned in *key,
54 if key is non-NULL. After the last entry in the hashmap NULL is
56 void *pa_hashmap_iterate(pa_hashmap
*h
, void **state
, const void**key
);
58 void *pa_hashmap_steal_first(pa_hashmap
*h
);
60 void *pa_hashmap_get_first(pa_hashmap
*h
);