5 * (c) 2000 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of the mLib utilities library.
12 * mLib is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * mLib is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with mLib; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
35 /*----- Header files ------------------------------------------------------*/
45 /*----- Data structures ---------------------------------------------------*/
47 typedef struct assoc_table {
52 typedef struct assoc_base {
57 typedef struct { hash_iter i; } assoc_iter;
59 #define ASSOC_ATOM(p) (((assoc_base *)(p))->a + 0)
61 /*----- Functions provided ------------------------------------------------*/
63 /* --- @assoc_create@ --- *
65 * Arguments: @assoc_table *t@ = pointer to an association table
69 * Use: Creates a new association table.
72 extern void assoc_create(assoc_table */*t*/);
74 /* --- @assoc_destroy@ --- *
76 * Arguments: @assoc_table *t@ = pointer to an association table
80 * Use: Destroys an association table.
83 extern void assoc_destroy(assoc_table */*t*/);
85 /* --- @assoc_find@ --- *
87 * Arguments: @assoc_table *t@ = pointer to an association table
88 * @atom *a@ = an atom to label the item
89 * @size_t sz@ = size of block to allocate
90 * @unsigned *f@ = pointer to `found' flag
92 * Returns: A pointer to the item located or null.
94 * Use: Looks up an atom in an association table. If the atom is
95 * found, the association is returned. If not, and @sz@ is
96 * zero, a null pointer is returned. Otherwise, a block of size
97 * @sz@ is allocated, its @assoc_base@ header is filled in, and
98 * the pointer returned. The flag @*f@ is cleared if the item
99 * couldn't be found, or set if it was.
101 * All the atoms used in a particular table should
104 extern void *assoc_find(assoc_table */*t*/, atom */*a*/,
105 size_t /*sz*/, unsigned */*f*/);
107 /* --- @assoc_remove@ --- *
109 * Arguments: @assoc_table *t@ = pointer to an association table
110 * @void *p@ = pointer to a block to remove
114 * Use: Removes an association from a table.
117 extern void assoc_remove(assoc_table */*t*/, void */*p*/);
119 /* --- @assoc_mkiter@, @assoc_next@ --- *
121 * Arguments: @assoc_iter *i@ = pointer to an iterator
122 * @assoc_table *t@ = pointer to an association table
124 * Returns: Next association, or null, for @assoc_next@; nothing for
127 * Use: Iterates over the associations in a table.
130 #define ASSOC_MKITER(i_, t_) HASH_MKITER(&(i_)->i, &(t_)->t)
132 #define ASSOC_NEXT(i_, p) do { \
134 HASH_NEXT(&(i_)->i, _q); \
138 extern void assoc_mkiter(assoc_iter */*i*/, assoc_table */*t*/);
139 extern void *assoc_next(assoc_iter */*i*/);
141 /*----- That's all, folks -------------------------------------------------*/