3 * $Id: assoc.h,v 1.3 2004/04/08 01:36:11 mdw Exp $
7 * (c) 2000 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 /*----- Header files ------------------------------------------------------*/
47 /*----- Data structures ---------------------------------------------------*/
49 typedef struct assoc_table {
54 typedef struct assoc_base {
59 typedef struct { hash_iter i; } assoc_iter;
61 #define ASSOC_ATOM(p) (((assoc_base *)(p))->a + 0)
63 /*----- Functions provided ------------------------------------------------*/
65 /* --- @assoc_create@ --- *
67 * Arguments: @assoc_table *t@ = pointer to an association table
71 * Use: Creates a new association table.
74 extern void assoc_create(assoc_table */*t*/);
76 /* --- @assoc_destroy@ --- *
78 * Arguments: @assoc_table *t@ = pointer to an association table
82 * Use: Destroys an association table.
85 extern void assoc_destroy(assoc_table */*t*/);
87 /* --- @assoc_find@ --- *
89 * Arguments: @assoc_table *t@ = pointer to an association table
90 * @atom *a@ = an atom to label the item
91 * @size_t sz@ = size of block to allocate
92 * @unsigned *f@ = pointer to `found' flag
94 * Returns: A pointer to the item located or null.
96 * Use: Looks up an atom in an association table. If the atom is
97 * found, the association is returned. If not, and @sz@ is
98 * zero, a null pointer is returned. Otherwise, a block of size
99 * @sz@ is allocated, its @assoc_base@ header is filled in, and
100 * the pointer returned. The flag @*f@ is cleared if the item
101 * couldn't be found, or set if it was.
103 * All the atoms used in a particular table should
106 extern void *assoc_find(assoc_table */*t*/, atom */*a*/,
107 size_t /*sz*/, unsigned */*f*/);
109 /* --- @assoc_remove@ --- *
111 * Arguments: @assoc_table *t@ = pointer to an association table
112 * @void *p@ = pointer to a block to remove
116 * Use: Removes an association from a table.
119 extern void assoc_remove(assoc_table */*t*/, void */*p*/);
121 /* --- @assoc_mkiter@, @assoc_next@ --- *
123 * Arguments: @assoc_iter *i@ = pointer to an iterator
124 * @assoc_table *t@ = pointer to an association table
126 * Returns: Next association, or null, for @assoc_next@; nothing for
129 * Use: Iterates over the associations in a table.
132 #define ASSOC_MKITER(i_, t_) HASH_MKITER(&(i_)->i, &(t_)->t)
134 #define ASSOC_NEXT(i_, p) do { \
136 HASH_NEXT(&(i_)->i, _q); \
140 extern void assoc_mkiter(assoc_iter */*i*/, assoc_table */*t*/);
141 extern void *assoc_next(assoc_iter */*i*/);
143 /*----- That's all, folks -------------------------------------------------*/