]>
code.delx.au - pulseaudio/blob - src/pulsecore/hashmap.h
7 This file is part of PulseAudio.
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 /* Simple Implementation of a hash table. Memory management is the
26 * user's job. It's a good idea to have the key pointer point to a
27 * string in the value data. */
29 typedef struct pa_hashmap pa_hashmap
;
31 /* Create a new hashmap. Use the specified functions for hashing and comparing objects in the map */
32 pa_hashmap
*pa_hashmap_new(unsigned (*hash_func
) (const void *p
), int (*compare_func
) (const void*a
, const void*b
));
34 /* Free the hash table. Calls the specified function for every value in the table. The function may be NULL */
35 void pa_hashmap_free(pa_hashmap
*, void (*free_func
)(void *p
, void *userdata
), void *userdata
);
37 /* Returns non-zero when the entry already exists */
38 int pa_hashmap_put(pa_hashmap
*h
, const void *key
, void *value
);
39 void* pa_hashmap_get(pa_hashmap
*h
, const void *key
);
41 /* Returns the data of the entry while removing */
42 void* pa_hashmap_remove(pa_hashmap
*h
, const void *key
);
44 unsigned pa_hashmap_size(pa_hashmap
*h
);
46 /* May be used to iterate through the hashmap. Initially the opaque
47 pointer *state has to be set to NULL. The hashmap may not be
48 modified during iteration. The key of the entry is returned in
49 *key, if key is non-NULL. After the last entry in the hashmap NULL
51 void *pa_hashmap_iterate(pa_hashmap
*h
, void **state
, const void**key
);