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 __OGGZ_TABLE_H__ 34 #define __OGGZ_TABLE_H__ 35 36 /** \file 37 * A lookup table. 38 * 39 * OggzTable is provided for convenience to allow the storage of 40 * serialno-specific data. 41 */ 42 43 /** 44 * A table of key-value pairs. 45 */ 46 typedef void OggzTable; 47 48 /** 49 * Instantiate a new OggzTable 50 * \returns A new OggzTable 51 * \retval NULL Could not allocate memory for table 52 */ 53 OggzTable * 54 oggz_table_new (void); 55 56 /** 57 * Delete an OggzTable 58 * \param table An OggzTable 59 */ 60 void 61 oggz_table_delete (OggzTable * table); 62 63 /** 64 * Insert an element into a table. If a previous value existed for this key, 65 * it is overwritten with the new data element. 66 * \param table An OggzTable 67 * \param key Key to access this data element 68 * \param data The new element to add 69 * \retval data If the element was successfully added 70 * \retval NULL If adding the element failed due to a realloc() error 71 */ 72 void * 73 oggz_table_insert (OggzTable * table, long key, void * data); 74 75 /** 76 * Remove the element of an OggzTable indexed by a given key 77 * \param table An OggzTable 78 * \param key a key 79 * \retval 0 Success 80 * \retval -1 Not found 81 */ 82 int 83 oggz_table_remove (OggzTable * table, long key); 84 85 /** 86 * Retrieve the element of an OggzTable indexed by a given key 87 * \param table An OggzTable 88 * \param key a key 89 * \returns The element indexed by \a key 90 * \retval NULL \a table is undefined, or no element is indexed by \a key 91 */ 92 void * 93 oggz_table_lookup (OggzTable * table, long key); 94 95 /** 96 * Query the number of elements in an OggzTable 97 * \param table An OggzTable 98 * \returns the number of elements in \a table 99 */ 100 int 101 oggz_table_size (OggzTable * table); 102 103 /** 104 * Retrieve the nth element of an OggzTable, and optionally its key 105 * \param table An OggzTable 106 * \param n An index into the \a table 107 * \param key Return pointer for key corresponding to nth data element 108 * of \a table. Ignored if NULL. 109 * \returns The nth data element of \a table 110 * \retval NULL \a table is undefined, or \a n is out of range 111 */ 112 void * 113 oggz_table_nth (OggzTable * table, int n, long * key); 114 115 #endif /* __OGGZ_TABLE_H__ */ 116