liboggz  1.1.1
oggz_table.h
Go to the documentation of this file.
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 
46 typedef void OggzTable;
47 
53 OggzTable *
54 oggz_table_new (void);
55 
60 void
62 
72 void *
73 oggz_table_insert (OggzTable * table, long key, void * data);
74 
82 int
83 oggz_table_remove (OggzTable * table, long key);
84 
92 void *
93 oggz_table_lookup (OggzTable * table, long key);
94 
100 int
101 oggz_table_size (OggzTable * table);
102 
112 void *
113 oggz_table_nth (OggzTable * table, int n, long * key);
114 
115 #endif /* __OGGZ_TABLE_H__ */
void OggzTable
A table of key-value pairs.
Definition: oggz_table.h:46
void * oggz_table_lookup(OggzTable *table, long key)
Retrieve the element of an OggzTable indexed by a given key.
int oggz_table_size(OggzTable *table)
Query the number of elements in an OggzTable.
int oggz_table_remove(OggzTable *table, long key)
Remove the element of an OggzTable indexed by a given key.
void * oggz_table_nth(OggzTable *table, int n, long *key)
Retrieve the nth element of an OggzTable, and optionally its key.
void * oggz_table_insert(OggzTable *table, long key, void *data)
Insert an element into a table.
void oggz_table_delete(OggzTable *table)
Delete an OggzTable.
OggzTable * oggz_table_new(void)
Instantiate a new OggzTable.