code.delx.au - pulseaudio/blob - src/pulsecore/hashmap.h

   1 #ifndef foopulsecorehashmaphfoo
   2 #define foopulsecorehashmaphfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2008 Lennart Poettering
   8
   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.
  13
  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.
  18
  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
  22   USA.
  23 ***/
  24
  25 #include <pulsecore/idxset.h>
  26
  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. */
  30
  31 typedef struct pa_hashmap pa_hashmap;
  32
  33 /* Create a new hashmap. Use the specified functions for hashing and comparing objects in the map */
  34 pa_hashmap *pa_hashmap_new(pa_hash_func_t hash_func, pa_compare_func_t compare_func);
  35
  36 /* Free the hash table. Calls the specified function for every value in the table. The function may be NULL */
  37 void pa_hashmap_free(pa_hashmap*, pa_free2_cb_t free_cb, void *userdata);
  38
  39 /* Add an entry to the hashmap. Returns non-zero when the entry already exists */
  40 int pa_hashmap_put(pa_hashmap *h, const void *key, void *value);
  41
  42 /* Return an entry from the hashmap */
  43 void* pa_hashmap_get(pa_hashmap *h, const void *key);
  44
  45 /* Returns the data of the entry while removing */
  46 void* pa_hashmap_remove(pa_hashmap *h, const void *key);
  47
  48 /* Return the current number of entries of the hashmap */
  49 unsigned pa_hashmap_size(pa_hashmap *h);
  50
  51 /* Return TRUE if the hashmap is empty */
  52 pa_bool_t pa_hashmap_isempty(pa_hashmap *h);
  53
  54 /* May be used to iterate through the hashmap. Initially the opaque
  55    pointer *state has to be set to NULL. The hashmap may not be
  56    modified during iteration -- except for deleting the current entry
  57    via pa_hashmap_remove(). The key of the entry is returned in *key,
  58    if key is non-NULL. After the last entry in the hashmap NULL is
  59    returned. */
  60 void *pa_hashmap_iterate(pa_hashmap *h, void **state, const void**key);
  61
  62 /* Remove the oldest entry in the hashmap and return it */
  63 void *pa_hashmap_steal_first(pa_hashmap *h);
  64
  65 /* Return the oldest entry in the hashmap */
  66 void* pa_hashmap_first(pa_hashmap *h);
  67
  68 #endif