mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-02 09:01:46 -05:00
1f0961368f
* add typedefs for public structs and enums and drop the struct/enum prefixs from all uses where it makes sense git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@447 fefdeb5f-60dc-0310-8127-8f9354f1896f
94 lines
3.9 KiB
C
94 lines
3.9 KiB
C
#ifndef fooidxsethfoo
|
|
#define fooidxsethfoo
|
|
|
|
/* $Id$ */
|
|
|
|
/***
|
|
This file is part of polypaudio.
|
|
|
|
polypaudio is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as
|
|
published by the Free Software Foundation; either version 2.1 of the
|
|
License, or (at your option) any later version.
|
|
|
|
polypaudio is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with polypaudio; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
USA.
|
|
***/
|
|
|
|
#include <inttypes.h>
|
|
|
|
/* A combination of a set and a dynamic array. Entries are indexable
|
|
* both through a numeric automatically generated index and the entry's
|
|
* data pointer. As usual, memory management is the user's job. */
|
|
|
|
/* A special index value denoting the invalid index. */
|
|
#define PA_IDXSET_INVALID ((uint32_t) -1)
|
|
|
|
/* Generic implementations for hash and comparison functions. Just
|
|
* compares the pointer or calculates the hash value directly from the
|
|
* pointer value. */
|
|
unsigned pa_idxset_trivial_hash_func(const void *p);
|
|
int pa_idxset_trivial_compare_func(const void *a, const void *b);
|
|
|
|
/* Generic implementations for hash and comparison functions for strings. */
|
|
unsigned pa_idxset_string_hash_func(const void *p);
|
|
int pa_idxset_string_compare_func(const void *a, const void *b);
|
|
|
|
typedef struct pa_idxset pa_idxset;
|
|
|
|
/* Instantiate a new idxset with the specified hash and comparison functions */
|
|
pa_idxset* pa_idxset_new(unsigned (*hash_func) (const void *p), int (*compare_func) (const void*a, const void*b));
|
|
|
|
/* Free the idxset. When the idxset is not empty the specified function is called for every entry contained */
|
|
void pa_idxset_free(pa_idxset *s, void (*free_func) (void *p, void *userdata), void *userdata);
|
|
|
|
/* Store a new item in the idxset. The index of the item is returned in *idx */
|
|
int pa_idxset_put(pa_idxset*s, void *p, uint32_t *idx);
|
|
|
|
/* Get the entry by its idx */
|
|
void* pa_idxset_get_by_index(pa_idxset*s, uint32_t idx);
|
|
|
|
/* Get the entry by its data. The idx is returned in *index */
|
|
void* pa_idxset_get_by_data(pa_idxset*s, const void *p, uint32_t *idx);
|
|
|
|
/* Similar to pa_idxset_get_by_index(), but removes the entry from the idxset. */
|
|
void* pa_idxset_remove_by_index(pa_idxset*s, uint32_t idx);
|
|
|
|
/* Similar to pa_idxset_get_by_data(), but removes the entry from the idxset */
|
|
void* pa_idxset_remove_by_data(pa_idxset*s, const void *p, uint32_t *idx);
|
|
|
|
/* This may be used to iterate through all entries. When called with
|
|
an invalid index value it returns the first entry, otherwise the
|
|
next following. The function is best called with *idx =
|
|
PA_IDXSET_VALID first. It is safe to manipulate the idxset between
|
|
the calls. It is not guaranteed that all entries have already been
|
|
returned before the an entry is returned the second time.*/
|
|
void* pa_idxset_rrobin(pa_idxset *s, uint32_t *idx);
|
|
|
|
/* Return the oldest entry in the idxset. Fill in its index in *idx. */
|
|
void* pa_idxset_first(pa_idxset *s, uint32_t *idx);
|
|
|
|
/* Return the entry following the entry indexed by *idx. After the
|
|
* call *index contains the index of the returned
|
|
* object. pa_idxset_first() and pa_idxset_next() may be used to
|
|
* iterate through the set.*/
|
|
void *pa_idxset_next(pa_idxset *s, uint32_t *idx);
|
|
|
|
/* Call a function for every item in the set. If the callback function
|
|
returns -1, the loop is terminated. If *del is set to non-zero that
|
|
specific item is removed. It is not safe to call any other
|
|
functions on the idxset while pa_idxset_foreach is executed. */
|
|
int pa_idxset_foreach(pa_idxset*s, int (*func)(void *p, uint32_t idx, int *del, void*userdata), void *userdata);
|
|
|
|
unsigned pa_idxset_size(pa_idxset*s);
|
|
|
|
int pa_idxset_isempty(pa_idxset *s);
|
|
|
|
#endif
|