1 /* 2 Copyright (C) 2003 Commonwealth Scientific and Industrial Research 3 Organisation (CSIRO) Australia 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 - Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 12 - Redistributions in binary form must reproduce the above copyright 13 notice, this list of conditions and the following disclaimer in the 14 documentation and/or other materials provided with the distribution. 15 16 - Neither the name of CSIRO Australia nor the names of its 17 contributors may be used to endorse or promote products derived from 18 this software without specific prior written permission. 19 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 23 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR 24 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifndef __FS_VECTOR_H__ 34 #define __FS_VECTOR_H__ 35 36 typedef void FishSoundVector; 37 38 typedef int (*FishSoundFunc) (void * data); 39 typedef int (*FishSoundCmpFunc) (void * data1, void * data2); 40 41 FishSoundVector * 42 fs_vector_new (FishSoundCmpFunc cmp); 43 44 void 45 fs_vector_delete (FishSoundVector * vector); 46 47 void * 48 fs_vector_nth (FishSoundVector * vector, int n); 49 50 int 51 fs_vector_find_index (FishSoundVector * vector, const void * data); 52 53 void * 54 fs_vector_find (FishSoundVector * vector, const void * data); 55 56 int 57 fs_vector_foreach (FishSoundVector * vector, FishSoundFunc func); 58 59 int 60 fs_vector_size (FishSoundVector * vector); 61 62 /** 63 * Add an element to a vector. 64 * \param vector An FishSoundVector 65 * \param data The new element to add 66 * \retval data If the element was successfully added 67 * \retval NULL If adding the element failed due to a realloc() error 68 */ 69 void * 70 fs_vector_insert (FishSoundVector * vector, void * data); 71 72 /** 73 * Remove a (void *) element of a vector 74 * \retval \a vector on success 75 * \retval NULL on failure (realloc error) 76 */ 77 FishSoundVector * 78 fs_vector_remove (FishSoundVector * vector, void * data); 79 80 #endif /* __FS_VECTOR_H__ */ 81